Skip to content
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

Jump to bottom

Publish documentation on GitHub Page #25

Merged
merged 8 commits into from
Feb 20, 2023
Merged

Publish documentation on GitHub Page #25

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
afb7df4
Update documentation for gh-page #4
Ludee Feb 20, 2023
9030d4b
Add action to deploy documentation #4
Ludee Feb 20, 2023
12762f5
Add placeholder for documentation badge #4
Ludee Feb 20, 2023
22378c8
Update documenation for GitHub Page workflow #4
Ludee Feb 20, 2023
0f3cc64
Update docs badge #4
Ludee Feb 20, 2023
9f8c462
Update README text and link #4
Ludee Feb 20, 2023
0b012df
Fix rst syntax #4
Ludee Feb 20, 2023
3f9c34c
Update changelog #4
Ludee Feb 20, 2023
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
Next Next commit
Update documentation for gh-page #4
  • Loading branch information
@Ludee
Ludee committed Feb 20, 2023
commit afb7df443f680215a99c57810c2d1888c61fbadb
7 changes: 6 additions & 1 deletion docs/documentation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,10 @@
`mkdocs build` build the documentation

### Publish
Publish MkDocs project on github pages (requires permissions on repository) <br>
Publish MkDocs project on **GitHub Pages** (requires permissions on repository) <br>
`mkdocs gh-deploy` manually deploy the local docs files to github pages

Deploy with **GitHub Actions**
The file `.github\workflows\gh-pages.yml` creates an automated GitHub workflow.
It is configured that it is pushed to the branch `gh-page` and then deployed online.
A commit on the `production` branch triggers the workflow.