Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

No output from automodule:: directive

See original GitHub issue

Module is loaded and parsed correctly (make html works)
no markdown is rendered for the ‘automodule’ section.

Sphinx output:

Running Sphinx v1.8.2
making output directory...
building [mo]: targets for 0 po files that are out of date
building [markdown]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index                                                                                                                                                   
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                                                                    
build succeeded, 1 warning.

The markdown files are in _build/markdown.
/home/[...]/sphinx/index.rst:: WARNING: The desc element not yet supported in Markdown.

index.rst

.. Foo documentation master file, created by
   sphinx-quickstart on Tue Dec 11 15:25:35 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Foo's documentation!
==============================

.. automodule:: foo.api
   :members:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

index.md

<!-- Foo documentation master file, created by
sphinx-quickstart on Tue Dec 11 15:25:35 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. -->
# Welcome to Foo’s documentation!

# Indices and tables

* [Index](https://localhost/)

* [Module Index](https://localhost/)

* [Search Page](https://localhost/)

…let me know if you can use some more info.

Issue Analytics

State:
Created 5 years ago
Comments:20 (15 by maintainers)

Top GitHub Comments

2reactions

manneohrstromcommented, Dec 30, 2018

Heads up that i have an experimental branch going here to better support common sphinx directives - including auto-doc stuff: https://github.com/manneohrstrom/sphinx-markdown-builder

Once cleaned up a bit, i’ll submit a PR.

0reactions

clayrissercommented, Feb 21, 2019

@theobarnhart-USGS, your issue has been fixed with pull request #12

Please update to v0.4.1

Top Results From Across the Web

No output from automodule:: directive · Issue #5 - GitHub

Module is loaded and parsed correctly (make html works) no markdown is rendered for the 'automodule' section. Sphinx output: Running Sphinx ...

Read The Docs not working with automodule - Stack Overflow

So, I have no idea why automodule is listed as an unknown directive. python · python-sphinx · docstring · read-the-docs · Share.

sphinx.ext.autodoc – Include documentation from docstrings

It allows to suppress inherited members of several classes on the module at once by specifying the option to automodule directive. Note: this...

sphinx.ext.autodoc – Include documentation from docstrings

All autodoc directives support the noindex flag option that has the same effect as for standard py:function etc. directives: no index entries are...

svn.python.org/projects/doctools/trunk/CHANGES

The `automodule` directive now supports the ``synopsis``, ``deprecated`` and ``platform`` ... but the directive will only create a target and no output.