diff --git a/content/sphinx.md b/content/sphinx.md index e4b0e3c..9ff9ca7 100644 --- a/content/sphinx.md +++ b/content/sphinx.md @@ -357,30 +357,25 @@ def multiply(a: float, b: float) -> float: return a * b ``` -2. Add a file `api.md` in the same folder as `index.rst`, with the following content: -````md -# API reference - -## example +2. In the file `conf.py` modify "extensions" and add 3 lines: +```python +extensions = ['myst_parser', "autodoc2"] -```{eval-rst} -.. automodule:: example - :members: +autodoc2_packages = [ + "multiply.py" +] ``` -```` -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(".")) +4. List `apidocs/index` in the toctree in `index.rst`. +```rst +.. toctree:: + :maxdepth: 2 + :caption: Contents: -extensions = ['myst_parser', "sphinx.ext.autodoc"] + some-feature.md + apidocs/index ``` -4. List the `api.md` file in `index.rst`. - 5. Re-build the documentation and check the "API reference" section. `````