Skip to main content

Sphinx Python Domain to DocFX YAML Generator

Project description

Sphinx DocFX YAML

.. image::

Sphinx DocFX YAML is an exporter for the Sphinx Autodoc module into `DocFX YAML <>`_.

You can read the full documentation online at


.. toctree::
:maxdepth: 2


Basic Workflow

* Write RST that includes Python `autodoc <>`_
* Render internal doctree into YAML
* Output YAML into output directory


First you need to install docfx-yaml:

.. code:: bash

pip install sphinx-docfx-yaml

Then add it to your Sphinx project's ````:

.. code:: python

# 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::

Then build your documentation::

make html

Inside your build directory (``_build/html`` usually),
the ``docfx_yaml`` will contain the YAML files that are output.

.. Modes

There are two output modes that specify the structure of the YAML files.
The first is ``module`` which means that the YAML files will be output in files corresponding to the name of their module.
The second modes is ``rst`` which outputs them in the same structure as the RST files they were defined in.


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`.

Napoleon Support

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``.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx-docfx-yaml-1.2.64.tar.gz (22.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page