WIP: Remove module list in the sidebar

[core-man]

Fixes #443.

[seisman]

这会导致一堆警告，因为这些文件都没有被包含到文档里。

[github-actions]

This comment was written by the Continuous Documentation bot!

• Preview: https://gmt-china.github.io/sitepreview/gmt-china/GMT_docs/module/index.html
• Commit hash: 423c128

[core-man]

See sphinx-doc/sphinx#5281. We could try two solutions based on https://stackoverflow.com/questions/15249340/warning-document-isnt-included-in-any-toctree-for-included-file.

1. Add :orphan: to the top of the `.rst* document to get rid of the warning. See file-wide-metadata
2. Update conf.py file with something like: exclude_patterns = ['modules/*.rst']. But this will also exclude index.rst. See exclude_patterns

[seisman]

See sphinx-doc/sphinx#5281. We could try two solutions based on stackoverflow.com/questions/15249340/warning-document-isnt-included-in-any-toctree-for-included-file.

1. Add :orphan: to the top of the `.rst* document to get rid of the warning
2. Update conf.py file with something like: exclude_patterns = ['modules/*.rst']. But this will also exclude index.rst.

由于没有被加到 toctree 里，所有模块的文档都会变成“野”文件。在显示上会有不同：

Before	After

基于同样的原因，我猜测所有模块都不会被显示到PDF里。

[core-man]

See #442 (comment):

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

[core-man]

由于没有被加到 toctree 里，所有模块的文档都会变成“野”文件。在显示上会有不同：

Before After

基于同样的原因，我猜测所有模块都不会被显示到PDF里。

我在 e83c630 中将 :orphan: 加入 basemap 测试，因为我本地机器无法编译。

[core-man]

还是表现为“野”文档，虽然网址没问题，警告也消失了。PDF 估计也有问题。

还是需要把所有文档包含在 TOC 里，所以按照类型包含每个模块以减少 TOC 的长度？

[core-man]

I reverted the changes. How about generating some .rst files to include different kinds of modules, e.g., session, plotting, 1d-data? For example, the session.rst will contain begin, end, figure, subplot, inset, docs, and clear. This will make the url for each module look like https://docs.gmt-china.org/latest/module/session/end/ instead of https://docs.gmt-china.org/latest/module/end/.

[seisman]

I reverted the changes. How about generating some .rst files to include different kinds of modules, e.g., session, plotting, 1d-data? For example, the session.rst will contain begin, end, figure, subplot, inset, docs, and clear. This will make the url for each module look like docs.gmt-china.org/latest/module/session/end instead of docs.gmt-china.org/latest/module/end.

No, do not break the URLs.

[core-man]

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

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

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

看来必须二选一了。

[ZMAlt]

这个问题仍没有办法解决吗？
gmt 官方也是用的 "includehidden": False，或许我们应该和官方一致，减少维护负担