Documentation page: mkdocs & GitHub pages #449
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
jherland
reviewed
Sep 16, 2024
mknorps
force-pushed
the
mknorps/documentation-init
branch
7 times, most recently
from
82f046d to
4932a58
Compare
Add mkdocs as a documentation framework for FawltyDeps. Update dependencies with a new `docs` dependencies group. Add material-mkdocs.
mknorps
force-pushed
the
mknorps/documentation-init
branch
2 times, most recently
from
6c410db to
ce7a0ab
Compare
mknorps
force-pushed
the
mknorps/documentation-init
branch
2 times, most recently
from
b7f16d5 to
dfb1799
Compare
Create content for the documentation page
mknorps
force-pushed
the
mknorps/documentation-init
branch
4 times, most recently
from
5870a05 to
d218819
Compare
Content of README should be shorter. Information suplocated in `docs` is removed.
mknorps
force-pushed
the
mknorps/documentation-init
branch
from
d218819 to
a7e8e0e
Compare
mknorps
changed the title
jherland
requested changes
Jan 7, 2025
Rewrite front page of the documentation as per @jherland's suggestion Co-authored-by: Johan Herland <[email protected]>
Co-authored-by: Johan Herland <[email protected]>
…eference to usage and configuration
jherland
reviewed
Feb 12, 2025
Provide more detail explaining why/when to use each of these command-line options. Co-authored-by: Johan Herland <[email protected]>
Co-authored-by: Johan Herland <[email protected]>
Co-authored-by: Johan Herland <[email protected]>
Poetry v2 drops support for Python v3.8 which we are still using.
mknorps
force-pushed
the
mknorps/documentation-init
branch
from
953ca04 to
ecacda5
Compare
jherland
approved these changes
Feb 21, 2025
There was a problem hiding this comment.
I took another look now, and except for two open questions (#449 (comment) and #449 (comment)) I think this is ready to get merged. 🎉
I also notice that the preview of the documentation page on https://tweag.github.io/FawltyDeps/ does not appear to be updated with the latest changes (for one, the menu structure on the left-hand side does not reflect the nav structure in mkdocs.yml).
jherland
approved these changes
Feb 24, 2025
Co-authored-by: Johan Herland <[email protected]>
Co-authored-by: Johan Herland <[email protected]>
Co-authored-by: Johan Herland <[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.
In this PR, a documentation page using mkdocs and deployed on GitHub pages is added.
Documentation content
Documentation page is based on the content available in the current README.md file. The content is split and grouped according to diataxis principles to provide explanations, usage guide and FAQs for FawltyDeps.
To build documentation, mkdocs with mkdocs-material are used due to simplicity and wide support.
Deployment
Documentation page is deployed on GitHub pages (see Settings -> Pages) and is using the content of gh-pages branch.
Content of gh-pages is automatically created with GitHub Action, following the documentation of mkdocs-material.
Local tests
First, install docs dependencies:
Then build and serve locally: