Documentation hosting on Github Pages #11
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hackallcode
requested changes
Jul 31, 2025
hackallcode
requested changes
Aug 4, 2025
choseenonee
reviewed
Aug 6, 2025
choseenonee
reviewed
Aug 6, 2025
choseenonee
reviewed
Aug 6, 2025
choseenonee
reviewed
Aug 6, 2025
choseenonee
reviewed
Aug 6, 2025
choseenonee
reviewed
Aug 6, 2025
choseenonee
previously approved these changes
Aug 6, 2025
hackallcode
reviewed
Aug 6, 2025
Co-authored-by: Vladimir Severov <[email protected]>
hackallcode
approved these changes
Aug 7, 2025
hackallcode
added a commit
that referenced
this pull request
Aug 7, 2025
Before this PR, the only way to access the documentation was by browsing through the repository's markdown files. Using the mkdocs framework, an alternative way was created to view documentation as a website. This patch contains: - Mkdocs config file `mkdocs.yml`. - Small corrections in .md files for more correct rendering on the website. - Custom hooks before site build to ensure .md file links remain accurate in both the website and repository versions of the docs. - CI workflow to deploy the documentation site to GitHub Pages. To check how the site looks locally, you need to: ``` make doc ``` Open documentation on http://localhost:8000/ Important: - In the repository settings, set the Github Actions source for Github Pages. Settings -> Pages -> Build and deployment: "GitHub Actions" - The documentation is deployed in the `github-pages` environment. You can set up rules for each environment (for example, a timer for deferred deployment) Settings -> Environment -> [env-name] Co-authored-by: Vladimir Severov <[email protected]>
hackallcode
added a commit
that referenced
this pull request
Aug 7, 2025
Before this PR, the only way to access the documentation was by browsing through the repository's markdown files. Using the mkdocs framework, an alternative way was created to view documentation as a website. This patch contains: - Mkdocs config file `mkdocs.yml`. - Small corrections in .md files for more correct rendering on the website. - Custom hooks before site build to ensure .md file links remain accurate in both the website and repository versions of the docs. - CI workflow to deploy the documentation site to GitHub Pages. To check how the site looks locally, you need to: ``` make doc ``` Open documentation on http://localhost:8000/ Important: - In the repository settings, set the Github Actions source for Github Pages. Settings -> Pages -> Build and deployment: "GitHub Actions" - The documentation is deployed in the `github-pages` environment. You can set up rules for each environment (for example, a timer for deferred deployment) Settings -> Environment -> [env-name] Co-authored-by: Vladimir Severov <[email protected]>
hackallcode
added a commit
that referenced
this pull request
Aug 7, 2025
Before this PR, the only way to access the documentation was by browsing through the repository's markdown files. Using the mkdocs framework, an alternative way was created to view documentation as a website. This patch contains: - Mkdocs config file `mkdocs.yml`. - Small corrections in .md files for more correct rendering on the website. - Custom hooks before site build to ensure .md file links remain accurate in both the website and repository versions of the docs. - CI workflow to deploy the documentation site to GitHub Pages. To check how the site looks locally, you need to: ``` make doc ``` Open documentation on http://localhost:8000/ Important: - In the repository settings, set the Github Actions source for Github Pages. Settings -> Pages -> Build and deployment: "GitHub Actions" - The documentation is deployed in the `github-pages` environment. You can set up rules for each environment (for example, a timer for deferred deployment) Settings -> Environment -> [env-name] Co-authored-by: Vladimir Severov <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this PR, the only way to access the documentation was by browsing through the repository's markdown files.
Using the mkdocs framework, an alternative way was created to view documentation as a website.
This patch contains:
mkdocs.yml.To check how the site looks locally, you need to:
Open documentation on http://localhost:8000/
Important:
Settings -> Pages -> Build and deployment: "GitHub Actions"
github-pagesenvironment.You can set up rules for each environment (for example, a timer for deferred deployment)
Settings -> Environment -> [env-name]