Set up documentation site #277
Merged
Conversation
This file contains 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
Links, spacing etc.
This allows us to use the original README for now, until we're ready to ditch it and break it up into bits.
springfall2008
approved these changes
Nov 7, 2023
|
So far looks good, just noticed it was draft actually |
|
Yep, I was just creating the PR to check that I had permissions to do it 😃 I'll let you know when it's done. |
Merge forked documentation back into branch in main Predbat
|
Can you think whether you'd like the documentation to be rebuilt and published on new commits to |
|
I guess we could rebuild on release? |
|
Thanks, I'll sort the config for that. Yep, I think building on a release makes sense. |
|
See #276 for latest changes. I'm happy with this if you are. |
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.
This PR takes the existing content from the README and breaks it down into separate files in the
docsfolder, publishing them using GitHub Pages and GitHub Actions.The aim is to create a more easily accessible, and searchable, site than the current very long README.
It uses
mkdocsto build the HTML pages for the documentation site, based on the Markdown files.mkdocs.ymldefines the navigation bar at the side (this allows controlling the order of pages, which would otherwise be in alphabetic order), and also sets the theme and other settings.Closes #276