Skip to content
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

Merged
merged 8 commits into from
Dec 11, 2019
Merged

Conversation

rossbar
Copy link
Contributor

@rossbar rossbar commented Dec 10, 2019

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:

  • In 69de7fa, I replaced the bash syntax highlighting with latex - the resulting syntax highlighting
    is better for equation environments but not great for math in $$, though at least the back
    slashes are no longer treated as escape/special characters.
  • In 455e206 I removed a cell from the docs that I couldn't make sense of. My reasoning for
    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.
  • 82bf163 represents the biggest change. I think the toc.yaml in the docs was outdated as it still
    had the title key word, though it is no longer used in the actual toc.yaml as the titles are being
    inferred. 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!

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
@choldgraf
Copy link
Collaborator

Nice! These all look great. A few quick points:

  • Textbooks with Jupyter is the old version of this project, so yes we should definitely rename any references to it, thanks for that!
  • For the toc.yml point - it is partially correct. You can still specify title: in the toc.yml file, and then it will be used in the 'official' page title instead of whatever the first header is. So the order of preference goes like this:
  1. Titles specified in toc.yml
  2. Inferred title if the page begins with a top-level header
  3. Inferred title from the page's file name

Do you think that's too much complexity to introduce in the notebooks.ipynb doc?

And thanks for the kind note about contributing documentation :-)

@rossbar
Copy link
Contributor Author

rossbar commented Dec 11, 2019

Regarding the toc.yaml point - The reason I suggested the change on the Anatomy of a Jupyter book page is because the sample that is shown in the page doesn't match the structure of the acutal toc.yaml in the demo, which has removed the explicit title tags to rely on inferred titles instead. I thought this was confusing because if you look at the title tags in the code blocks in Anatomy of a Jupyter book, they don't actually match the names of the pages.

My intention was to eliminate this ambiguity by syncing up the code blocks in Anatomy of a Jupyter book with the toc.yaml included in the demo.

Let me know what you think!

@choldgraf
Copy link
Collaborator

That makes a lot of sense! Merged 🎉

@choldgraf choldgraf merged commit 39618eb into jupyter-book:master Dec 11, 2019
@rossbar rossbar deleted the doc branch December 13, 2019 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants