diff --git a/{{cookiecutter.repo_name}}/docs/conf.py b/{{cookiecutter.repo_name}}/docs/conf.py index a7577f7..ab70317 100644 --- a/{{cookiecutter.repo_name}}/docs/conf.py +++ b/{{cookiecutter.repo_name}}/docs/conf.py @@ -50,10 +50,11 @@ 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx', 'sphinx.ext.extlinks', - 'sphinx_design' - + 'sphinx_design', + 'sphinx_copybutton', ] + autosummary_generate = True napoleon_google_docstring = False napoleon_use_param = False diff --git a/{{cookiecutter.repo_name}}/docs/getting_started.rst b/{{cookiecutter.repo_name}}/docs/getting_started.rst index a00ecb4..e47ac7b 100644 --- a/{{cookiecutter.repo_name}}/docs/getting_started.rst +++ b/{{cookiecutter.repo_name}}/docs/getting_started.rst @@ -1,4 +1,9 @@ Getting Started =============== -This page details how to get started with {{cookiecutter.project_name}}. + +You might choose to write an overview tutorial or set of tutorials. + +.. code-block:: python + + import {{cookiecutter.repo_name}} diff --git a/{{cookiecutter.repo_name}}/docs/requirements.yaml b/{{cookiecutter.repo_name}}/docs/requirements.yaml index 8e9f474..b9fdff0 100644 --- a/{{cookiecutter.repo_name}}/docs/requirements.yaml +++ b/{{cookiecutter.repo_name}}/docs/requirements.yaml @@ -1,4 +1,4 @@ -name: docs +name: docs_{{cookiecutter.project_name}} channels: {% if cookiecutter.dependency_source == 'Prefer conda-forge over the default anaconda channel with pip fallback' %} - conda-forge @@ -11,15 +11,19 @@ dependencies: {% if cookiecutter.dependency_source == 'Prefer conda-forge over the default anaconda channel with pip fallback' %} - pydata-sphinx-theme - sphinx-design + - sphinx-copybutton {% endif %} {% if cookiecutter.dependency_source == 'Prefer default anaconda channel with pip fallback' %} # Pip-only installs - pip: + - -e ../ - pydata-sphinx-theme - sphinx-design + - sphinx-copybutton {% else %} # Pip-only installs - #- pip: + - pip: + - -e ../ {% endif %}