From fbd1bd6e370739fdcc364784616cf71d90ad28cf Mon Sep 17 00:00:00 2001 From: Erik Tjong Kim Sang Date: Tue, 20 Apr 2021 14:14:24 +0200 Subject: [PATCH] removed apidocs choice --- cookiecutter.json | 1 - {{cookiecutter.project_name}}/docs/conf.py | 2 -- {{cookiecutter.project_name}}/docs/index.rst | 2 -- .../{{cookiecutter.package_name}}/__init__.py | 2 +- .../{{cookiecutter.package_name}}/my_module.py | 2 +- 5 files changed, 2 insertions(+), 7 deletions(-) diff --git a/cookiecutter.json b/cookiecutter.json index 7830ed87..0a351692 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -6,7 +6,6 @@ "version": "0.1.0", "github_organization": "", "license": ["Apache Software License 2.0", "MIT license", "BSD license", "ISC license", "GNU General Public License v3 or later", "Not open source"], - "apidoc": ["no", "yes"], "full_name": "John Smith", "email": "yourname@esciencecenter.nl", "copyright_holder": "Netherlands eScience Center", diff --git a/{{cookiecutter.project_name}}/docs/conf.py b/{{cookiecutter.project_name}}/docs/conf.py index 39cbd1f4..d18ab35e 100644 --- a/{{cookiecutter.project_name}}/docs/conf.py +++ b/{{cookiecutter.project_name}}/docs/conf.py @@ -78,7 +78,6 @@ # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False -{% if cookiecutter.apidoc == "yes" %} # -- Run apidoc plug-in manually, as readthedocs doesn't support it ------- # See https://github.com/rtfd/readthedocs.org/issues/1139 def run_apidoc(_): @@ -110,7 +109,6 @@ def run_apidoc(_): def setup(app): app.connect("builder-inited", run_apidoc) -{% endif %} # -- Options for HTML output ---------------------------------------------- diff --git a/{{cookiecutter.project_name}}/docs/index.rst b/{{cookiecutter.project_name}}/docs/index.rst index e71f8a14..d8ef571c 100644 --- a/{{cookiecutter.project_name}}/docs/index.rst +++ b/{{cookiecutter.project_name}}/docs/index.rst @@ -10,7 +10,6 @@ Welcome to {{ cookiecutter.package_name }}'s documentation! :maxdepth: 2 :caption: Contents: -{% if cookiecutter.apidoc == 'yes' %} API Reference ============= @@ -18,7 +17,6 @@ API Reference :maxdepth: 2 {{ cookiecutter.package_name }} -{% endif %} Indices and tables ================== diff --git a/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/__init__.py b/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/__init__.py index b874d2c0..418484ea 100644 --- a/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/__init__.py +++ b/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/__init__.py @@ -1,4 +1,4 @@ -{% if cookiecutter.apidoc == "yes" %}"""Documentation about {{ cookiecutter.package_name }}"""{% endif %} +"""Documentation about {{ cookiecutter.package_name }}""" import logging from .__version__ import __version__ diff --git a/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/my_module.py b/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/my_module.py index fcf8ae8e..3479f21b 100644 --- a/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/my_module.py +++ b/{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/my_module.py @@ -1,4 +1,4 @@ -{%-if cookiecutter.apidoc == "yes" %}"""Documentation about the {{ cookiecutter.package_name }} module."""{% endif %} +"""Documentation about the {{ cookiecutter.package_name }} module.""" import logging