Make stardoc our documentation tool #359
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
This is now compiling, and we will see if the rendering is looking good.
This is removing the good rendering, as we do not use html output which was removed in stardoc. This should probably be restored at some point but having an up to date documentation is more important than having a good looking one.
This way just ./update_docs.sh is going to update correctly the documentation
This was referenced Jun 29, 2020
Merged
mfarrugi
approved these changes
Jun 29, 2020
This will avoid us breaking accidently one of our development workflow.
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.
The current documentation was difficult to maintain and not in sync with the inline one.
These changes adjust the setting so we can generate the documentation in markdown format and it will continue to be served on Github pages, this time with an easy way to sync it.
Each commit of this PR have been made to be reviewed separately.
Fixes #337