Try fixing docs (#57)

docs/requirements.yaml

@@ -6,7 +6,7 @@ dependencies:
   - python
   - pip
 
-  - sphinx
+  - sphinx<7.0
   - sphinx_rtd_theme
 
   - tree

docs/source/conf.py

@@ -53,6 +53,7 @@
 # ones.
 extensions = [
     'sphinx.ext.mathjax',
+    'sphinx.ext.autosummary',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -72,12 +73,13 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db',
+                    '.DS_Store', 'generated/example-repository/*']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'

docs/source/index.rst

@@ -13,17 +13,16 @@ based on MDAnalysis.
 Starting repositories can be created from this template so you can focus on what's important: the science!
 
 **Features**
-
-* Python-centric skeletal structure with initial module files
-* Pre-configured ``setup.py`` for installation and packaging
-* Pre-configured Window, Linux, and OSX continuous integration on GitHub Actions
-* Choice of dependency locations through ``conda-forge``, default ``conda``, or ``pip``
-* Basic testing structure with `PyTest <https://docs.pytest.org/en/latest/>`_
-* Automatic ``git`` initialization + tag
-* GitHub Hooks
-* Automatic package version control with `Versioneer <https://github.com/warner/python-versioneer>`_
-* Sample data inclusion with packaging instructions
-* Basic documentation structure powered by `Sphinx <http://www.sphinx-doc.org/en/master/>`_
+   * Python-centric skeletal structure with initial module files
+   * Pre-configured ``setup.py`` for installation and packaging
+   * Pre-configured Window, Linux, and OSX continuous integration on GitHub Actions
+   * Choice of dependency locations through ``conda-forge``, default ``conda``, or ``pip``
+   * Basic testing structure with `PyTest <https://docs.pytest.org/en/latest/>`_
+   * Automatic ``git`` initialization + tag
+   * GitHub Hooks
+   * Automatic package version control with `Versioneer <https://github.com/warner/python-versioneer>`_
+   * Sample data inclusion with packaging instructions
+   * Basic documentation structure powered by `Sphinx <http://www.sphinx-doc.org/en/master/>`_
 
 
 .. toctree::

docs/source/usage.rst

@@ -4,9 +4,9 @@ Usage
 Getting up and running requires a short process.
 
 You will need the following:
-    * Python 3.8+
-    * The `cookiecutter`_ tool installed
-    * A GitHub account
+  * Python 3.8+
+  * The `cookiecutter`_ tool installed
+  * A GitHub account
 
 
 1. Use the cookiecutter to create a new project
@@ -35,7 +35,7 @@ Please see :ref:`options-label` for more details.
 The generated repository should be an initialised git repository.
 We now need to connect it to GitHub:
 
-#. `Create a new repository on GitHub`_ .
+#. `Create a new repository on GitHub <https://docs.github.com/en/get-started/quickstart/create-a-repo>`_ .
    Do not initialize the repo with a README, license, or any other files.
 #. Push the local repository to GitHub.
    GitHub should provide instructions for doing so, but in short:
@@ -123,3 +123,7 @@ To keep things clean and simple, we advise a few tips:
   as well as collaborate with other people.
   See `GitHub's documentation on PRs <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_
   for more information.
+
+
+.. _ReadTheDocs: https://docs.readthedocs.io/en/stable/index.html
+.. _cookiecutter: https://cookiecutter.readthedocs.io/en/stable/

{{cookiecutter.repo_name}}/docs/requirements.yaml

@@ -5,7 +5,7 @@ dependencies:
   - python
   - pip
 
-  - sphinx
+  - sphinx<7.0
 {% if cookiecutter.dependency_source == 'Prefer default anaconda channel with pip fallback' %}
   # Pip-only installs
   - pip:

{{cookiecutter.repo_name}}/docs/source/api.rst

@@ -4,4 +4,4 @@ API Documentation
 .. autosummary::
    :toctree: autosummary
 
-   {{cookiecutter.repo_name}}.canvas
+   {{cookiecutter.package_name}}.canvas

{{cookiecutter.repo_name}}/docs/source/conf.py

@@ -76,7 +76,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.