This is not an officially supported Google product.
This is a forked version of the original from https://github.com/docascode/sphinx-docfx-yaml.
Feel free to use this forked repository for personal or experimental use, use the original otherwise.
Sphinx DocFX YAML is an exporter for the Sphinx Autodoc module into DocFX YAML.
You can read the full documentation online at http://sphinx-docfx-yaml.readthedocs.io
.. toctree:: :glob: :maxdepth: 2 design layout api
- Write RST that includes Python autodoc
- Render internal doctree into YAML
- Output YAML into output directory
To use this forked version, install GCP docfx-yaml:
pip install gcp-sphinx-docfx-yaml
Then add it to your Sphinx project's conf.py
:
# Order matters here.
# The extension must be defined *after* autodoc,
# because it uses a signal that autodoc defines
extensions = ['sphinx.ext.autodoc', 'docfx_yaml.extension']
Make sure you are using autodoc in your code somewhere:
.. automodule:: foo.bar
Then build your documentation:
make html
Inside your build directory (_build/html
usually),
the docfx_yaml
will contain the YAML files that are output.
To run the tests in this repository, run:
pip install tox
tox -e docs
from the top directory of this repository.
Read more about the design in our :doc:`design`.
This project has a few different pieces at this point. It's primary goal was to integrate the Azure Python SDK into the docfx tooling. You can read more about the pieces currently set up in the :doc:`layout`.
We support sphinx.ext.napoleon
for parsing docstrings in other formats.
Currently all markup that maps to existing Sphinx info field lists will work,
along with Examples
.
In order to pull examples out,
you need the napoleon_use_admonition_for_examples
set to True
.