Set up mkdocs for generating documentation #27
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
|
|
jorgebay
reviewed
Sep 23, 2022
aureamunoz
force-pushed
the
setup-mkdocs
branch
from
e7f83b8
to
631662f
Compare
|
It's looking great, I'll take a look at it first thing tomorrow morning! In order to merge it, we will need the CLA signed :) |
jorgebay
approved these changes
Oct 11, 2022
There was a problem hiding this comment.
Looks awesome!
The build docs instructions are super clear and I was able to serve them locally.
There are some minor tweaks I had to do (like install mkdocs-material).
I think we can land this first in main and deal with the finishing touches in a follow up PR.
|
NICE @aureamunoz !!!!
|
|
Looks fantastic!! @aureamunoz |
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.
I put in place mkdocs for generating documentation. We should publish the generated site using github pages for example but that can be done in a separated PR.
At this moment, @vevi try to follow the instructions described in
CONTRIBUTING.md#Building the documentationand let me know how it goes :-)