Skip to content

Build offline docs #1049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: devel
Choose a base branch
from
Open

Build offline docs #1049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2d4a68
Update readme.md
nixfreak Dec 5, 2023
945edad
Merge pull request #2 from nixfreak/nixfreak-patch-2
nixfreak Dec 5, 2023
4567734
Update readme.md
nixfreak Dec 5, 2023
a15cdc7
Merge pull request #3 from nixfreak/nixfreak-patch-3
nixfreak Dec 5, 2023
e2099e7
Update intern.rst
nixfreak Dec 6, 2023
7b6e642
Merge pull request #4 from nixfreak/nixfreak-patch-4
nixfreak Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/intern.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* We follow |NimSkull|'s official style guide, see `<style_guide.html>`_.
* We follow |NimSkull|'s official style guide, see `<nep1.html>`_.

* Max line length is 100 characters.
* Provide spaces around binary operators if that enhances readability.
* Use a space after a colon, but not before it.
Expand Down
2 changes: 2 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,8 @@ git clone https://github.com/nim-works/nimskull.git
cd nimskull
./koch.py boot -d:release
./koch.py tools -d:release
Build all nimSkull documentation
./koch.py docs -d: release
Comment on lines +146 to +147
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that the step should be listed separately, below the "add the bin directory to your PATH" paragraph.

```

Finally, once you have finished the build steps (on Windows, Mac, or Linux) you
Expand Down