From 35aa9a822a189d934a762c978717a9ec1ab0fb0d Mon Sep 17 00:00:00 2001 From: Stephen L Arnold Date: Fri, 26 Sep 2025 20:21:01 -0700 Subject: [PATCH] chg: dev: add note about gh-pages branch, add Docs link to project urls * add note about rpmget as more fleshed out doorstop example Signed-off-by: Stephen L Arnold --- README.rst | 9 ++++++++- pyproject.toml | 1 + 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c8cd81a..437d8b5 100644 --- a/README.rst +++ b/README.rst @@ -45,6 +45,11 @@ checkout, run the following commands:: $ git push origin badges $ git checkout main +Make a ``gh-pages`` branch +-------------------------- + +Follow the same steps shown above, changing the branch name to ``gh-pages``. + .. _setuptools documentation: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html @@ -151,10 +156,12 @@ doorstop_ documents, eg:: Please see the doorstop Quick Start for an overview of the relevant doorstop -commands. +commands. See the `rpmget project`_ for a more fleshed out real-world example +of using doorstop_ and sphinx together. .. _doorstop Quick Start: https://doorstop.readthedocs.io/en/latest/getting-started/quickstart.html .. _doorstop: https://doorstop.readthedocs.io/en/latest/index.html +.. _rpmget project: https://github.com/sarnold/rpmget Tox diff --git a/pyproject.toml b/pyproject.toml index 37cdd74..ccc295d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -68,6 +68,7 @@ test = [ [project.urls] Homepage = "https://github.com/sarnold/simple-python-project" +Documentation = "https://sarnold.github.io/simple-python-project/" Repository = "https://github.com/sarnold/simple-python-project.git" Issues = "https://github.com/sarnold/simple-python-project/issues" Changelog = "https://github.com/sarnold/simple-python-project/blob/main/CHANGELOG.rst"