Fix bugs and Improve visual experience #150
Open
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.
The first bug
https://pytorch.org/tutorials/beginner/audio_preprocessing_tutorial.html#mel-filter-bank
It should be a
-
rather than+
in the right-menu.The bug is introduced by the wrong class. There should be no
not-expanded
class.The second bug
in jquery javascript of right-menu, we use
$(href)
to search for item in article with that id (e.g.,href=#torch
). However, it doesn't work if'.' in href
(e.g.,#torch.nn.Softmax
), because jquery will regardnn
andSoftmax
as classes. It requires backslashes'\\'
to escape the dot.This doesn't affect current pytorch docs, because there is no dot in right-menu items. But if we put the classes and methods generated by autodoc into the right-menu, which will leads to many problems.
torch.nn.Softmax
as an example.The third bug
sphinx 4.2.0 modify
<div class="section">
to<section>
, which makes some of our css setting not work, which causes the margin-top for each section not 0 (It should be 0 according to css), further leading to the visual bug for the right-menu at page bottom (because the height offset is calculated with wrong numbers.).https://pytorch.org/tutorials/beginner/audio_preprocessing_tutorial.html
Hide
shortcut-wrapper
at page bottom.https://pytorch.org/tutorials/beginner/audio_preprocessing_tutorial.html
In Tutorial,
shortcut-wrapper
get overlapped at page bottom. So I think it's better to hide it.