Skip to content

Commit a96a996

Browse files
committed
Added instructions for creating documentation to release_checklist.rst
1 parent b7d1a63 commit a96a996

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/developer_guide/release_checklist.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,20 @@ The ``twine`` utility can be used to upload the packages to PyPI:
125125

126126
.. code-block:: bash
127127
128-
$ twine register dist/lewis-x.y.z.tar.gz
129-
$ twine register dist/lewis-x.y.z-py3-none-any.whl
130128
$ twine upload dist/*
129+
130+
Note: requires a PyPi account and lewis permissions.
131+
132+
Uploading the documentation
133+
---------------------------
134+
135+
Building the documentation locally:
136+
137+
.. code-block:: bash
138+
139+
$ sphinx-build -b html docs/ docs/_build/html
140+
141+
Fix any errors if it fails to build and commit them.
142+
143+
Log on to https://readthedocs.org and check the lewis build passes.
144+

0 commit comments

Comments
 (0)