Skip to content

A mwe for sphinx with autodoc, autosummary and sphinx-gallery

Notifications You must be signed in to change notification settings

ImportanceOfBeingErnest/sphinx-mwe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx-mwe

This is a minimal working example for sphinx including autodoc, autosummary, and sphinx-gallery.

The sphinx-mwe-bug folder includes a bug. This is due to an Alias class being created in the module.

Sphinx-upperlowercase

This is a minimal example showing a bug with upper and lowercase, i.e. creating a documentation from a python file like

class Colorbar():
     # ...

def colorbar():
     # ...

where two objects differ just between upper and lower case leads to an error.

About

A mwe for sphinx with autodoc, autosummary and sphinx-gallery

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published