Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #37: Enable pywps autodoc extension #38

Merged
merged 1 commit into from
Jun 7, 2018
Merged

Fix #37: Enable pywps autodoc extension #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ Then:

For more details, see the `cookiecutter-pypackage tutorial`_.

See the `babybird <http://babybird.rtfd.io/>`_ example of a generated bird.

Development
-----------

Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
#'pywps.ext_autodoc', # Available on master branch. Will be distributed with the 4.2 release.
'pywps.ext_autodoc',
]

autoapi_type = 'python'
Expand Down
1 change: 1 addition & 0 deletions {{cookiecutter.project_slug}}/docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

installation
configuration
processes
changes

Indices and tables
Expand Down
29 changes: 29 additions & 0 deletions {{cookiecutter.project_slug}}/docs/source/processes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _processes:

Processes
=========

.. contents::
:local:
:depth: 1

Sleep
-----

.. autoprocess:: {{ cookiecutter.project_slug }}.processes.wps_sleep.Sleep
:docstring:
:skiplines: 1

Wordcounter
-----------

.. autoprocess:: {{ cookiecutter.project_slug }}.processes.wps_wordcounter.WordCounter
:docstring:
:skiplines: 1

InOut
-----

.. autoprocess:: {{ cookiecutter.project_slug }}.processes.wps_inout.InOut
:docstring:
:skiplines: 1
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pywps>=4.1.0
pywps>=4.0.0
jinja2
click
psutil
6 changes: 6 additions & 0 deletions {{cookiecutter.project_slug}}/rtd.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
-e git+https://github.com/geopython/pywps.git#egg=pywps
jinja2
click
psutil
sphinx>=1.7
sphinx-autoapi