Skip to content

Commit

Permalink
Merge pull request #1138 from flash62au/sphinx
Browse files Browse the repository at this point in the history
update github pages doco
  • Loading branch information
flash62au authored Jan 30, 2025
2 parents 6e7c70f + 0eb6803 commit f703442
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
21 changes: 14 additions & 7 deletions docs/about/contributing/website/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,12 +298,19 @@ You can optionally, setup *github pages* from you own repository on the GitHub w

1. Open the **GitHub website**
2. Open/select your repository ``https://github.com/<your_account_name>/dcc-ex.github.io``
3. Open the ``Settings`` page
4. Select ``Pages`` in the left navigation
5. Choose `Deploy from a branch`
6. Choose `gh-pages` and `root`
7. Click :guilabel:`Save`

This takes time, every time you push any changes, but you will eventually be able to see your own version of the website at ``https://<your_account_name>.github.io/dcc-ex.github.io/``.
3. Click the ``branches`` link
4. On 'Branches' page click :guilabel:`new Branch`
5. Give the new branch the name ``gh-pages``
6. Select a Source of ``DCC-EX/dcc-ex.github.io`` and ``gh-pages``
7. clich :guilabel:`Create New branch`
8. Open the ``Settings`` page
9. Select ``Pages`` in the left navigation
10. Choose `Deploy from a branch`
11. Choose `gh-pages` and `root`
12. Click :guilabel:`Save`

In theory that should be enough, but the last time we tried this we also needed to create a manual build action. If you go to the 'Actions' page and you *can't* see an action named **'Docs'**, then contact the development ateam nd we will halp you create a manual build action. (Which for some unknown reason then shows the automatic 'Docs' action.)

Building the pages and deplying takes time, every time you push any changes, but you will eventually be able to see your own version of the website at ``https://<your_account_name>.github.io/dcc-ex.github.io/``.

You can see the state of the processing of your changes by looking at the ``Actions`` page. It will also tell you there if there are any errors.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,4 @@ DCC-EX Model Railroading

About Us and the Project<about/index>
about/index-contributing

0 comments on commit f703442

Please sign in to comment.