Skip to content

Example sphinx automodule example to improve sphinx-markdown-builder

License

Notifications You must be signed in to change notification settings

Liam-Deacon/sphinx-automodule-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sphinx-automodule-example

Example sphinx automodule example to improve sphinx-markdown-builder with Restructured Text table.

Installation

Clone repo...

pip install .

Steps to reproduce:

cd docs
make html
make markdown

The differences can be seen in the built html (docs/build/html/index.html) and the built markdown (docs/build/markdown/index.md).

I.e. the methods docstrings, argument types and return types are not listed.

About

Example sphinx automodule example to improve sphinx-markdown-builder

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages