Skip to content

📝 highlight deployment from gh-pages branch #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
enryH wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📝 highlight deployment from gh-pages branch #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ contain extensions and themes that are used additionally to sphinx to build the
The layout of the website is defined in the `index.md` file.

> Have look at `.github/workflows/build_website.yaml` to see how the site is built
> if you are interested.
> if you are interested, which publishes the `.build` folder on the `gh-pages` branch.

- Open a terminal (GitHub Codespaces)
- install required packages from [`requirements.txt`](requirements.txt):
Expand All @@ -84,11 +84,13 @@ The layout of the website is defined in the `index.md` file.

Follow
[these instructions](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)
to publish the website using GitHub Pages.
to publish the website using GitHub Pages, but please use the `gh-pages` branch:

- Select the `gh-pages` branch as the source for the GitHub Pages site (currently step 7)
- add the deployed url to your "About" on the right sight of the repository

> The `gh-pages` branch is not connected to the `main` branch or any other branch. It
> is only used to serve the build website.

## Changing the topic

Expand Down
Loading