-
Notifications
You must be signed in to change notification settings - Fork 663
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.
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
[DOC] Minor changes to documentation #452
Conversation
Used inline code blocks to be consistent with the first instance, rather than escaping the asterisks.
One of the notebooks used in generating the feature guide appears to have had an outdated cell that referenced Textbooks with Jupyter and had an unclear reference to a configuration option that does not appear to be available any longer.
* Fixed comment in cell removal notebook. * Fixed a comment in the description of tags for cell removal.
The current description of the toc.yml is out of sync with the actual toc.yml file, which might be confusing for users reading the docs. Replaced the code snippet with the sample from the current toc.yml. Also added a few sentences to denote how the titles of the documents is determined, as that has changed since the previous toc example. Includes link to relevant page in the beta features docs
Nice! These all look great. A few quick points:
Do you think that's too much complexity to introduce in the And thanks for the kind note about contributing documentation :-) |
Regarding the My intention was to eliminate this ambiguity by syncing up the code blocks in Anatomy of a Jupyter book with the Let me know what you think! |
That makes a lot of sense! Merged 🎉 |
I noticed a few items in the documentation/website as I was working my way through the demo to build the jupyter-book site. Most of the changes I've proposed are minor, though there are a few that need extra attention as I am less sure about them:
bash
syntax highlighting withlatex
- the resulting syntax highlightingis better for
equation
environments but not great for math in$$
, though at least the backslashes are no longer treated as escape/special characters.
removing the cell was that it seemed to be referencing an older name (Textbooks with Jupyter)
for the project. It's possible this cell should be updated rather than removed, but I didn't
quite understand what it was saying.
toc.yaml
in the docs was outdated as it stillhad the
title
key word, though it is no longer used in the actualtoc.yaml
as the titles are beinginferred. I updated the example in the docs to reflect this while adding a few sentences explaining
that the project has been configured for automatic page titling in the
_config.yaml
.The site that results from a local build using this branch can be found at https://rossbar.github.io/jupyterbook-site-test/intro.html. It can be used for a side-by-side comparison with https://jupyterbook.org/ to see how the proposed changes look on the rendered site.
BTW - I was very impressed with the contribution guidelines for this project - they're among the most detailed I've seen and definitely helped give me confidence with this PR!