docs

RatInABox-Lab · Dec 5, 2023 · caa2fde · caa2fde
1 parent 6cab407
commit caa2fde
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -26,3 +26,5 @@ We have included an extra GitHub actions workflow in `.github/workflows/docs_bui
 * The published docs are by default hosted at `https://<github_username_or_organization>.github.io/<package_name>/`. To enable hosting, you will need to go to the settings of your repository, and under the "Pages" section, select the `gh-pages` branch as the source for your GitHub pages site.
 * A popular alternative to GitHub pages for hosting the documentation is [Read the Docs](https://readthedocs.org/). To enable hosting on Read the Docs, you will need to create an account on the website and follow the instructions to link your GitHub repository to your Read the Docs account.
 
+## Publishing override
+Go onto the github actions page on GitHub and go to the "Build Sphinx docs and deploy to GitHub Pages" workflow. Click "Run workflow". Should manually build and deploy docs with requiring a new tag. 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -110,7 +110,7 @@
         }
     ],
     "logo": {
-        "text": f"{project} v{release}",
+        "text": f"{project}", #v{release} for release version
         "image_light": "logo_small.png",
         "image_dark": "logo_small.png",
     },