drgn/.readthedocs.yaml

version: 2
build:
  os: ubuntu-22.04
  tools:
    python: "3"
sphinx:
  configuration: docs/conf.py
python:
  install:
    - requirements: docs/requirements.txt
Document with Sphinx drgn has pretty thorough in-program documentation, but it doesn't have a nice overview or introduction to the basic concepts. This commit adds that using Sphinx. In order to avoid documenting everything in two places, the libdrgn bindings have their docstrings generated from the API documentation. The alternative would be to use Sphinx's autodoc extension, but that's not as flexible and would also require building the extension to build the docs. The documentation for the helpers is generated using autodoc and a small custom extension. 2019-04-04 09:27:23 +01:00			`version: 2`
docs: add new required options to .readthedocs.yaml Read the Docs is going to require build.os and build.tools.python to be configured [1]. It also looks like the recommended configuration filename is .readthedocs.yaml instead of .readthedocs.yml. Fix both. 1: https://blog.readthedocs.com/use-build-os-config/ Signed-off-by: Omar Sandoval <osandov@osandov.com> 2023-09-07 18:25:50 +01:00			`build:`
			`os: ubuntu-22.04`
			`tools:`
docs: try fixing invalid build.tools.python in .readthedocs.yaml The error message from Read the Docs says: "Problem in your project's configuration. Invalid configuration option "build.tools.python": expected one of (2.7, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3, miniconda3-4.7, mambaforge-4.10, mambaforge-22.9), got 3". Maybe it got a number and expects a string. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2023-09-07 18:29:12 +01:00			`python: "3"`
Document with Sphinx drgn has pretty thorough in-program documentation, but it doesn't have a nice overview or introduction to the basic concepts. This commit adds that using Sphinx. In order to avoid documenting everything in two places, the libdrgn bindings have their docstrings generated from the API documentation. The alternative would be to use Sphinx's autodoc extension, but that's not as flexible and would also require building the extension to build the docs. The documentation for the helpers is generated using autodoc and a small custom extension. 2019-04-04 09:27:23 +01:00			`sphinx:`
			`configuration: docs/conf.py`
docs: set required Sphinx version for Read the Docs Read the Docs defaults to Sphinx 1.8.5. This version was released in 2019 and doesn't know about the :classmethod: option, so the documentation for Object.from_bytes_() is missing from drgn.readthedocs.io. Set the required version to the current latest version as recommended by Read the Docs: https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#pinning-dependencies. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2021-08-17 22:50:17 +01:00			`python:`
			`install:`
			`- requirements: docs/requirements.txt`