diff --git a/content/sphinx.md b/content/sphinx.md index f6d0b62..e4b0e3c 100644 --- a/content/sphinx.md +++ b/content/sphinx.md @@ -357,25 +357,30 @@ def multiply(a: float, b: float) -> float: return a * b ``` -2. In the file `conf.py` modify "extensions" and add 3 lines: -```python -extensions = ['myst_parser', "sphinx.ext.autodoc"] +2. Add a file `api.md` in the same folder as `index.rst`, with the following content: +````md +# API reference + +## example -autodoc2_packages = [ - "multiply.py" -] +```{eval-rst} +.. automodule:: example + :members: ``` +```` -4. List `apidocs/index` in the toctree in `index.rst`. -```rst -.. toctree:: - :maxdepth: 2 - :caption: Contents: +3. In the file `conf.py` add 3 lines and modify "extensions": +```python +# this is a trick to make sphinx find the modules in the parent directory +import os +import sys +sys.path.insert(0, os.path.abspath(".")) - some-feature.md - apidocs/index +extensions = ['myst_parser', "sphinx.ext.autodoc"] ``` +4. List the `api.md` file in `index.rst`. + 5. Re-build the documentation and check the "API reference" section. `````