-
Notifications
You must be signed in to change notification settings - Fork 200
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
UPDATE: Sphinx v4.0.0 #364
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
bbdfe27
Update Sphinx to include v4
choldgraf 6da8076
Fix logo for upgrade
choldgraf 9e983da
Merge branch 'master' into sphinx-4
chrisjsewell 59ab648
Tests use Sphinx 4
choldgraf 9c07d6c
Merge branch 'master' into sphinx-4
mmcky 215ddda
upgrade myst-nb to 0.13
mmcky 7bdc1c5
Revert "upgrade myst-nb to 0.13"
mmcky 4cab78d
Update MyST NB and click
choldgraf 8b7f5b4
Update setup.py
choldgraf 48b7556
Fixing import for Margin directive
choldgraf 61392b9
remove default from myst-parser settings
mmcky ba3aa83
add in sphinx3 and sphinx4 fixture tracking and update CI
mmcky e188ee1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 797523b
Exclude docutils==0.17 for now
mmcky 9b8f93f
Merge branch 'sphinx-4' of https://github.com/ExecutableBookProject/s…
mmcky f473b30
Merge branch 'master' into sphinx-4
mmcky File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<div class="d-none d-md-block col-md-2 bd-toc show"> | ||
<div class="tocsection onthispage pt-5 pb-3"> | ||
<i class="fas fa-list"> | ||
</i> | ||
Contents | ||
</div> | ||
<nav aria-label="Page" id="bd-toc-nav"> | ||
<ul class="visible nav section-nav flex-column"> | ||
<li class="toc-h1 nav-item toc-entry"> | ||
<a class="reference internal nav-link" href="#"> | ||
4.1. A page with multiple top-level titles | ||
</a> | ||
<ul class="visible nav section-nav flex-column"> | ||
<li class="toc-h2 nav-item toc-entry"> | ||
<a class="reference internal nav-link" href="#a-sub-heading"> | ||
4.1.1. A sub-heading | ||
</a> | ||
</li> | ||
</ul> | ||
</li> | ||
<li class="toc-h1 nav-item toc-entry"> | ||
<a class="reference internal nav-link" href="#another-top-level-title"> | ||
4.2. Another top-level title | ||
</a> | ||
<ul class="visible nav section-nav flex-column"> | ||
<li class="toc-h2 nav-item toc-entry"> | ||
<a class="reference internal nav-link" href="#another-sub-heading"> | ||
4.2.1. Another sub-heading | ||
</a> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</nav> | ||
</div> |
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<div class="d-none d-md-block col-md-2 bd-toc show"> | ||
<div class="tocsection onthispage pt-5 pb-3"> | ||
<i class="fas fa-list"> | ||
</i> | ||
Contents | ||
</div> | ||
<nav aria-label="Page" id="bd-toc-nav"> | ||
<ul class="visible nav section-nav flex-column"> | ||
<li class="toc-h2 nav-item toc-entry"> | ||
<a class="reference internal nav-link" href="#here-s-a-sub-heading"> | ||
4.3.1. Here’s a sub-heading | ||
</a> | ||
</li> | ||
<li class="toc-h2 nav-item toc-entry"> | ||
<a class="reference internal nav-link" href="#here-s-another"> | ||
4.3.2. Here’s another | ||
</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
</div> |
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<div class="d-none d-md-block col-md-2 bd-toc show"> | ||
</div> |
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
<div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation"> | ||
<div class="navbar-brand-box"> | ||
<a class="navbar-brand text-wrap" href="#"> | ||
<h1 class="site-logo" id="site-title"> | ||
Sphinx Book Theme documentation | ||
</h1> | ||
</a> | ||
</div> | ||
<form action="search.html" class="bd-search d-flex align-items-center" method="get"> | ||
<i class="icon fas fa-search"> | ||
</i> | ||
<input aria-label="Search the docs ..." autocomplete="off" class="form-control" id="search-input" name="q" placeholder="Search the docs ..." type="search"/> | ||
</form> | ||
<nav aria-label="Main" class="bd-links" id="bd-docs-nav"> | ||
<div class="bd-toc-item active"> | ||
<p class="caption" role="heading"> | ||
<span class="caption-text"> | ||
My caption | ||
</span> | ||
</p> | ||
<ul class="nav bd-sidenav"> | ||
<li class="toctree-l1"> | ||
<a class="reference internal" href="page1.html"> | ||
1. Page 1 | ||
</a> | ||
</li> | ||
<li class="toctree-l1"> | ||
<a class="reference internal" href="page2.html"> | ||
2. Page 2 | ||
</a> | ||
</li> | ||
<li class="toctree-l1 has-children"> | ||
<a class="reference internal" href="section1/index.html"> | ||
3. Section 1 index | ||
</a> | ||
<input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> | ||
<label for="toctree-checkbox-1"> | ||
<i class="fas fa-chevron-down"> | ||
</i> | ||
</label> | ||
<ul> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="section1/page1.html"> | ||
3.1. Section 1 page1 | ||
</a> | ||
</li> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="section1/ntbk.html"> | ||
3.2. A test notebook | ||
</a> | ||
</li> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="section1/ntbkmd.html"> | ||
3.3. Section 1 page1 | ||
</a> | ||
</li> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="section1/ntbk_octave.html"> | ||
3.4. Octave | ||
</a> | ||
</li> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="section1/ntbk_julia.html"> | ||
3.5. Julia | ||
</a> | ||
</li> | ||
</ul> | ||
</input> | ||
</li> | ||
<li class="toctree-l1 has-children"> | ||
<a class="reference internal" href="titles/index.html"> | ||
4. Testing titles and TOCtree | ||
</a> | ||
<input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> | ||
<label for="toctree-checkbox-2"> | ||
<i class="fas fa-chevron-down"> | ||
</i> | ||
</label> | ||
<ul> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="titles/page-multipletitles.html"> | ||
4.1. A page with multiple top-level titles | ||
</a> | ||
</li> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="titles/page-onetitle.html"> | ||
4.3. A page with one title and sub-headings | ||
</a> | ||
</li> | ||
<li class="toctree-l2"> | ||
<a class="reference internal" href="titles/page-onetitlenoheadings.html"> | ||
4.4. A page with a title but no sub-headings | ||
</a> | ||
</li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l1"> | ||
<a class="reference external" href="https://google.com"> | ||
https://google.com | ||
</a> | ||
</li> | ||
</ul> | ||
</div> | ||
</nav> | ||
<!-- To handle the deprecated key --> | ||
<div class="navbar_extra_footer"> | ||
Theme by the | ||
<a href="https://ebp.jupyterbook.org"> | ||
Executable Book Project | ||
</a> | ||
</div> | ||
</div> |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@choldgraf good find! Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh cool it looks like there are
html_logo
andlatex_logo
nowhttps://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=logo#confval-html_logo
This is something we will need to manage in jupyter-book to issue a depcration notice for
logo
in jupyter-book/jupyter-book#1438There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we may not need to deprecate it if we are managing it under the hood though!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK -- if
html
orlatex
isn't specified uselogo
-- I see where you are going