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

More consistent table of content for notebooks #1362

Merged
merged 11 commits into from
Nov 2, 2018

Conversation

jenshnielsen
Copy link
Collaborator

To render the notebooks nicely as part of our docs there should only be one 1 level heading at the top of the notebook. This changes a bunch of notebooks that had more.

In addition

  • Level 3 headings should be inside a level 2 section not freestanding. I have not double checked all instances but I have at least fixed on instance where this is not the case. That seems to cause the levels to be revers in the output. Which may be a bug in nbsphinx/nbconvert
  • Make the toc for instrument notebooks only one level deep. I think this makes it much easier to get an overview of which example are there. Still to do is to give them more consistent names
  • Correct a few typos here and there as i found them

@codecov
Copy link

codecov bot commented Oct 31, 2018

Codecov Report

Merging #1362 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1362      +/-   ##
==========================================
+ Coverage   73.15%   73.16%   +0.01%     
==========================================
  Files          79       79              
  Lines        9155     9196      +41     
==========================================
+ Hits         6697     6728      +31     
- Misses       2458     2468      +10

@jenshnielsen
Copy link
Collaborator Author

@QCoDeS/core Could someone have a quick look at this? It's quite simple but makes the presentation of notebooks in the docs so much nicer

@@ -25,9 +24,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Experiment container and dasets\n",
"# Experiment container and datasets\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

What is it about with the double # in the other notebooks? Sorry for not checking myself. I don't seem to find anything.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok now I get it sorry.... I was confused by the source view

Copy link
Contributor

@Dominik-Vogel Dominik-Vogel left a comment

Choose a reason for hiding this comment

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

Great that you are getting these docs sorted!

@Dominik-Vogel
Copy link
Contributor

Somehow my PR from yesterady fails here on 3.7, even though it passed in the original pr....

@jenshnielsen jenshnielsen merged commit 68f45cd into microsoft:master Nov 2, 2018
@jenshnielsen jenshnielsen deleted the notebook_toc branch November 2, 2018 10:02
giulioungaretti pushed a commit that referenced this pull request Nov 2, 2018
Merge: 85d458f 958fa1e
Author: Jens Hedegaard Nielsen <jenshnielsen@gmail.com>

    Merge pull request #1362 from jenshnielsen/notebook_toc
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.

None yet

2 participants