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.

Sign up for GitHub

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

Jump to bottom

WIP: Remove module list in the sidebar #444

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

WIP: Remove module list in the sidebar #444

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
09fe452
Change the order of api and module
core-man Jun 21, 2021
f9b7f9d
Test orphan in basemap
core-man Jun 21, 2021
ac6f880
Remove orphan in basemap
core-man Jun 25, 2021
b02f49c
Test level-2 layout
core-man Jun 26, 2021
8dea903
Merge branch 'master' into module
core-man Jun 26, 2021
2eb1874
Add includehidden in html_theme_options
core-man Jul 7, 2021
bdbfe73
Merge branch 'master' into module
core-man Jul 7, 2021
423c128
Merge branch 'master' into module
seisman Jul 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
html_theme_options = {
"prev_next_buttons_location": "bottom",
"sticky_navigation": False,
"includehidden": False,
Copy link
Member Author

@core-man core-man Jul 7, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

加这个设置的话，所有使用 :hidden: 的文件都不会显示在左侧了，但是目前以下文件使用了 :hidden::

  • index.rst: 这个文档都没有目录了 😄
  • dataset/index.rst
  • migrating/index.rst
  • module/index.rst
  • option/index.rst
  • proj/index.rst

为了左侧目录也能显示，就要在这些文件里去掉 hidden，但这样的话，页面里就会有目录。

看来必须二选一了。

}
html_context = {
"display_github": True,
Expand Down
2 changes: 1 addition & 1 deletion source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ GMT 是地球科学最广泛使用的制图软件之一。
dataset/index
dataset-CN/index
chinese/index
api/index
module/index
api/index
Comment on lines -79 to +80
Copy link
Member Author

Choose a reason for hiding this comment

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

See #442 (comment):

api也可以放在模块后面，一来我们很少看api 二来英文放在后面显得和谐


.. toctree::
:maxdepth: 3
Expand Down
1 change: 0 additions & 1 deletion source/module/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,6 @@
\setcounter{secnumdepth}{1}

.. toctree::
:maxdepth: 1
:hidden:

basemap
Expand Down