From a96a9969a2874fb094fb82da68663006035c97f6 Mon Sep 17 00:00:00 2001 From: Matt Clarke Date: Fri, 27 Nov 2020 15:02:03 +0100 Subject: [PATCH] Added instructions for creating documentation to release_checklist.rst --- docs/developer_guide/release_checklist.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/developer_guide/release_checklist.rst b/docs/developer_guide/release_checklist.rst index e6f26a0..78624f9 100644 --- a/docs/developer_guide/release_checklist.rst +++ b/docs/developer_guide/release_checklist.rst @@ -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. +