Skip to content

Commit

Permalink
Fixed errors in the tutorial (#79)
Browse files Browse the repository at this point in the history
* Tutorial still referenced the canvas function
* Code block was commented out
  • Loading branch information
ianmkenney authored Sep 21, 2023
1 parent 2264df3 commit e289972
Showing 1 changed file with 7 additions and 16 deletions.
23 changes: 7 additions & 16 deletions docs/source/makingakit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,8 @@ the following code block:
raise ValueError("Some RMSF values negative; overflow " +
"or underflow occurred")
Removing the ``canvas`` function and introducing the ``RMSF`` class requires we edit the default ``__init__.py`` file, or else importing will result in an error. Replace
.. code-block:: python
from .rmsfkit import canvas
with
To make our ``RMSF`` analysis class easier to access, we import it in ``__init__.py``. Add

.. code-block:: python
Expand Down Expand Up @@ -373,15 +368,11 @@ We can now build the documentation html files using the included ``Makefile``. W
make html
There will be a few errors:
This will convert the reStructuredText files into HTML in the ``_build`` directory.
Open ``index.html`` and look around.

#. Documentation language (defaults to English)
#. import failure for ``rmsfkit.canvas`` (since we removed this function)
#. attribute error for ``canvas`` (same reason as above)

Despite the errors, the documentation is generated in the ``_build/html/``
directory. Open ``index.html`` and look around. Notice that the "API Documentation"
page is blank. This is because within ``source/api.rst``, the only contents are:
Notice that the "API Documentation" does not contain all of the information found in the docstrings of our code.
This is because within ``source/api.rst``, the only contents are:

.. code-block:: rst
Expand All @@ -391,7 +382,7 @@ page is blank. This is because within ``source/api.rst``, the only contents are:
.. autosummary::
:toctree: autosummary
rmsfkit.canvas
rmsfkit
Instead, it should contain:

Expand Down Expand Up @@ -490,7 +481,7 @@ Add ``- sphinxcontrib-bibtex`` as an additional dependency here.

Update your environment with

.. code-block::bash
.. code-block:: bash
mamba env update --name rmsfkit -f requirements.yaml
Expand Down

0 comments on commit e289972

Please sign in to comment.