diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -60,6 +60,8 @@ * :ref:`Keycloak ` → learn how to use Keycloak, the authentication system used by |swh|'s web interface and public APIs +.. _components: + Components ---------- diff --git a/docs/tutorials/add-new-package.rst b/docs/tutorials/add-new-package.rst --- a/docs/tutorials/add-new-package.rst +++ b/docs/tutorials/add-new-package.rst @@ -76,6 +76,15 @@ bin/init-py-repo swh-new-repo +- Within that new repository, replace the ``swh-py-template`` entry in + ``docs/index.rst`` with the new package name ``swh-`` (e.g: + ``swh-scrubber``). + +.. code:: bash + + REPO_NAME=swh-new-repo # edit this part, keep the "swh-" prefix + sed -i -e "s/swh-py-template/$REPO_NAME/g" docs/index.rst + - Edit the default content of the template (`Example `__) - Configure **your local** pre-commit hook @@ -91,7 +100,8 @@ - Edit the ``.mrconfig`` file and declare the new repository (just duplicate one existing entry and adapt with the new package name) - - Commit file modification (`Example `__) + - Commit file modification (`Example + `__) Install CI jobs --------------- @@ -118,11 +128,14 @@ - Documentation repository is located in the swh-docs_ repository. -- Add the new package dependency in the top-level ``requirements-swh.txt`` and - ``requirements-swh-dev.txt`` +- Add the package dependency in the top-level ``requirements-swh.txt`` (publication + build) and ``requirements-swh-dev.txt`` (documentation development build). + +- Reference the package in the toc tree located in :ref:`docs/api-reference.rst + `. -- Add the new package entry in ``docs/index.rst`` with a concise description of the - package +- Reference the package in the index with its concise description located in + :ref:`docs/index.rst `. :: @@ -135,7 +148,8 @@ - ensure this builds fine locally (e.g run `tox`, then `make -C docs`) -- Then open a diff to advertise the new documentation entrypoints (`Example `__) +- Then open a diff to advertise the new documentation entrypoints (`Example + `__) .. _`swh phabricator instance`: https://forge.softwareheritage.org/