-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Upgrade documentation techstack #6470
Merged
ssheorey
merged 15 commits into
isl-org:master
from
saurabheights:khanduja/upgrade_documentation_techstack
Nov 14, 2023
Merged
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
4b583c8
Move conf.in.py to conf.py.
saurabheights c5da6aa
Upgrade all docs dependencies and replace open3d_sphinx_theme with sp…
saurabheights d813f3b
Lower docutils to version 0.17.0 and sort dependencies
saurabheights e3a5d38
Fix CI badges.
saurabheights cd4b7f9
Move to furo and upgrade all dependencies.
saurabheights f948044
Fix display of caption of toctree in furo theme.
saurabheights 7b23724
Remove only tag, was missing double colon.
saurabheights c7b9e14
Fix typo.
saurabheights 298045c
Convert admonition from note type to warning, considering many users …
saurabheights d1ebb72
Add css overrides and minor html changes to show documentation versio…
saurabheights ed4de40
Center align open3d-ml image.
saurabheights c6fc5e1
Fix code style and update CHANGELOG.md
saurabheights ad34fdb
todo_include_todos was given twice in conf.py, remove earlier entry.
saurabheights 6be9fed
Fix for references rendering.
ssheorey 93a0a5b
Merge branch 'master' of github.com:isl-org/Open3D into khanduja/upgr…
ssheorey 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
/* In furo, toctree captions needs to be enlarged. */ | ||
.toctree-wrapper.compound .caption { | ||
font-size: 150%; | ||
font-weight: bold; | ||
} | ||
|
||
/* Apply custom CSS for displaying docs version - https://github.com/pradyunsg/furo/pull/500 */ | ||
#furo-versions { | ||
font-size: var(--sidebar-item-font-size); | ||
} | ||
|
||
#furo-versions .caption { | ||
display: inline-block; | ||
color: var(--color-sidebar-caption-text); | ||
font-weight: bold; | ||
text-transform: uppercase; | ||
font-size: var(--sidebar-caption-font-size); | ||
padding-right: var(--sidebar-expander-width); | ||
margin-top: 0; | ||
} | ||
|
||
#furo-versions input[type=checkbox] { | ||
display: none; | ||
position: absolute; | ||
box-sizing: border-box; | ||
padding: 0; | ||
overflow: visible; | ||
} | ||
|
||
#furo-versions input[type=checkbox]:checked ~ .rst-other-versions { | ||
display: inline-block; | ||
line-height: var(--sidebar-item-line-height); | ||
padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal); | ||
text-decoration: none; | ||
} | ||
|
||
#furo-versions .rst-other-versions { | ||
display: none; | ||
} | ||
|
||
#furo-versions .versions-label { | ||
position: relative; | ||
float: right; | ||
} |
This file was deleted.
Oops, something went wrong.
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 @@ | ||
{% if display_all_docs_versions %} | ||
{# Add rst-badge after rst-versions for small badge style. #} | ||
<div id="furo-versions" class="rst-versions sidebar-tree" role="note" aria-label="versions" tabindex="0"> | ||
<p class="caption">Docs Version</p> | ||
<input type="checkbox" id="checkbox_toggle" class="toctree-checkbox versions-checkbox" role="switch"> | ||
<label id="versions-label" class="versions-label" for="checkbox_toggle"> | ||
<div class="visually-hidden">Toggle child pages in navigation</div> | ||
<i class="icon"> | ||
<svg> | ||
<use href="#svg-arrow-right"></use> | ||
</svg> | ||
</i> | ||
</label> | ||
|
||
<!-- A hack to include an external page to get around CORS policy --> | ||
<!-- https://stackoverflow.com/a/15250208/1255535 --> | ||
<div class="rst-other-versions"> | ||
<script src="http://www.open3d.org/docs/versions.js"></script> | ||
</div> | ||
</div> | ||
{% endif %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
sphinx==3.3.1 | ||
sphinx-rtd-theme==0.5.2 | ||
nbsphinx==0.8.3 | ||
matplotlib==3.3.3 | ||
jinja2==3.0.3 | ||
m2r2==0.2.7 | ||
mistune==0.8.4 | ||
docutils==0.20.1 | ||
furo==2023.9.10 | ||
jinja2==3.1.2 | ||
m2r2==0.3.3.post2 | ||
matplotlib==3.7.3 | ||
nbsphinx==0.9.3 | ||
sphinx==7.1.2 |
Oops, something went wrong.
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.
Wanted to highlight that since furo is center-aligned theme, unlike rtd, its better to go for center alignment for images. (IMO, although correct me if you have a contradicting thoughts).