Skip to content

Commit aa4bb4a

Browse files
authored
switch to autoapi for docs generation (#1368)
1 parent 6df3514 commit aa4bb4a

40 files changed

+26
-292
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ dist: dist/${MODULE}-$(VERSION).tar.gz
6868
dist/${MODULE}-$(VERSION).tar.gz: $(SOURCES)
6969
./setup.py sdist bdist_wheel
7070

71+
## docs : make the docs
72+
docs: FORCE
73+
cd docs && $(MAKE) html
74+
7175
## clean : clean up all temporary / machine-generated files
7276
clean: FORCE
7377
rm -f ${MODILE}/*.pyc tests/*.pyc

docs/conf.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@
3030
extensions = [
3131
"sphinx.ext.autodoc",
3232
"sphinx.ext.autosummary",
33+
"sphinx.ext.inheritance_diagram",
34+
"autoapi.extension",
35+
"sphinx_autodoc_typehints",
3336
"sphinx_rtd_theme",
3437
]
3538

@@ -58,3 +61,14 @@
5861
from pkg_resources import get_distribution
5962
release = get_distribution('cwltool').version
6063
version = '.'.join(release.split('.')[:2])
64+
65+
autoapi_dirs = ['../cwltool']
66+
autodoc_typehints = 'description'
67+
autoapi_keep_files = True
68+
autoapi_ignore = ['*migrations*', '*.pyi']
69+
autoapi_options = [ 'members', 'undoc-members', 'show-inheritance', 'show-inheritance-diagram', 'show-module-summary', 'imported-members', 'special-members' ]
70+
#sphinx-autodoc-typehints
71+
always_document_param_types = True
72+
# If False, do not add type info for undocumented parameters.
73+
# If True, add stub documentation for undocumented parameters to be able to add type info.
74+

docs/cwltool.argparser.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/cwltool.builder.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/cwltool.checker.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/cwltool.command_line_tool.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/cwltool.context.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/cwltool.cwlrdf.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/cwltool.docker.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/cwltool.docker_id.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)