Build offline docs #1049
Open
Build offline docs #1049
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
Added optional command to build nimSkull documents.
Update readme.md
Update readme.md
Change nep1.html to style_guide.html
Add style_guide.html link
zerbina
requested changes
Dec 6, 2023
There was a problem hiding this comment.
Showing within the readme how to build the offline documentation is a good idea, I think. I've left a review comment regarding the placement.
If you're working on multiple PRs, please make sure not to merge them into each other (as they are now).
Finally, please make sure to follow the PR message guidelines -- feel free to ask for help if something is unclear. The title should also be changed to mention that this is a documentation update rather than a change to the build process.
| @@ -250,7 +250,7 @@ The new runtime is active `when defined(nimV2)`. | |||
| Coding Guidelines | |||
| ================= | |||
|
|
|||
| * We follow |NimSkull|'s official style guide, see `<nep1.html>`_. | |||
| * We follow |NimSkull|'s official style guide, see `<style_guide.html>`_. | |||
There was a problem hiding this comment.
Suggested change
| * We follow |NimSkull|'s official style guide, see `<style_guide.html>`_. | |
| * We follow |NimSkull|'s official style guide, see `<nep1.html>`_. |
Comment on lines
+146
to
+147
| Build all nimSkull documentation | ||
| ./koch.py docs -d: release |
There was a problem hiding this comment.
I think that the step should be listed separately, below the "add the bin directory to your PATH" paragraph.
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.
Summary
Details
Fixes full_issue_url
Notes for Reviewers