Skip to content

Commit b69ce98

Browse files
authored
Merge pull request #194 from NLeSC/176-apidoc-selection
Removed apidocs choice from cookiecutter step
2 parents 0070857 + fbd1bd6 commit b69ce98

5 files changed

Lines changed: 2 additions & 7 deletions

File tree

cookiecutter.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"version": "0.1.0",
77
"github_organization": "<my-github-organization>",
88
"license": ["Apache Software License 2.0", "MIT license", "BSD license", "ISC license", "GNU General Public License v3 or later", "Not open source"],
9-
"apidoc": ["no", "yes"],
109
"full_name": "John Smith",
1110
"email": "yourname@esciencecenter.nl",
1211
"copyright_holder": "Netherlands eScience Center",

{{cookiecutter.project_name}}/docs/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@
7878
# If true, `todo` and `todoList` produce output, else they produce nothing.
7979
todo_include_todos = False
8080

81-
{% if cookiecutter.apidoc == "yes" %}
8281
# -- Run apidoc plug-in manually, as readthedocs doesn't support it -------
8382
# See https://github.com/rtfd/readthedocs.org/issues/1139
8483
def run_apidoc(_):
@@ -110,7 +109,6 @@ def run_apidoc(_):
110109

111110
def setup(app):
112111
app.connect("builder-inited", run_apidoc)
113-
{% endif %}
114112

115113
# -- Options for HTML output ----------------------------------------------
116114

{{cookiecutter.project_name}}/docs/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,13 @@ Welcome to {{ cookiecutter.package_name }}'s documentation!
1010
:maxdepth: 2
1111
:caption: Contents:
1212

13-
{% if cookiecutter.apidoc == 'yes' %}
1413
API Reference
1514
=============
1615

1716
.. toctree::
1817
:maxdepth: 2
1918

2019
{{ cookiecutter.package_name }} <apidocs/{{ cookiecutter.package_name }}.rst>
21-
{% endif %}
2220

2321
Indices and tables
2422
==================

{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% if cookiecutter.apidoc == "yes" %}"""Documentation about {{ cookiecutter.package_name }}"""{% endif %}
1+
"""Documentation about {{ cookiecutter.package_name }}"""
22
import logging
33
from .__version__ import __version__
44

{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/my_module.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{%-if cookiecutter.apidoc == "yes" %}"""Documentation about the {{ cookiecutter.package_name }} module."""{% endif %}
1+
"""Documentation about the {{ cookiecutter.package_name }} module."""
22
import logging
33

44

0 commit comments

Comments
 (0)