Skip to content

Commit

Permalink
Added instructions for creating documentation to release_checklist.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mattclarke committed Nov 27, 2020
1 parent b7d1a63 commit a96a996
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/developer_guide/release_checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,20 @@ The ``twine`` utility can be used to upload the packages to PyPI:

.. code-block:: bash
$ twine register dist/lewis-x.y.z.tar.gz
$ twine register dist/lewis-x.y.z-py3-none-any.whl
$ twine upload dist/*
Note: requires a PyPi account and lewis permissions.

Uploading the documentation
---------------------------

Building the documentation locally:

.. code-block:: bash
$ sphinx-build -b html docs/ docs/_build/html
Fix any errors if it fails to build and commit them.

Log on to https://readthedocs.org and check the lewis build passes.

0 comments on commit a96a996

Please # to comment.