Pull requests

#37 Merged
Repository
frasertweedale frasertweedale
Branch
stable
Repository
birkenfeld birkenfeld
Branch
stable

apidoc: read options from SPHINX_APIDOC_OPTIONS envvar

Author
  1. frasertweedale avatarfrasertweedale
Reviewers
Description

If the SPHINX_APIDOC_OPTIONS environment variable is defined, read OPTIONS from there, otherwise default to the existing value of OPTIONS, maintaining existing behaviour. This makes the behaviour of sphinx-apidoc somewhat configurable.

This change comes about from a need to instruct sphinx-apidoc *not* to generate autodoc stubs for undocument members.

Comments (0)

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.