Initial support for generating local documentation #655
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
|
@dmacvicar ❤️ ❤️ 😻 🐶 😍 |
MalloZup
approved these changes
Oct 9, 2019
There was a problem hiding this comment.
@dmacvicar looks great. Feel free to ping me in case any help needed in this direction
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.
We have the website directory in the tree, using upstream layout to be prepared for inclusion in the terraform-providers project.
This PR adds a docs directory with a Sphinx configuration that allows to generate html documentation from the original layout.
cd docs make htmlShould generate a beautiful website:
There are minor details that can be improved, but I think it is a good first step.
After this PR, my plan would be to enable CI to automatically publish the documentation, and then move some of it from README, and link it appropriately.