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.

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

Restructure documentation navigation #6420

Merged
merged 4 commits into from
Jan 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Added support for dropping nodes in `utils.to_dense_batch` in case `max_num_nodes` is smaller than the number of nodes ([#6124](https://github.com/pyg-team/pytorch_geometric/pull/6124))
- Added the RandLA-Net architecture as an example ([#5117](https://github.com/pyg-team/pytorch_geometric/pull/5117))
### Changed
- Re-structured the documentation ([#6420](https://github.com/pyg-team/pytorch_geometric/pull/6420))
- Fix the default arguments of `DataParallel` class ([#6376](https://github.com/pyg-team/pytorch_geometric/pull/6376))
- Fix `ImbalancedSampler` on sliced `InMemoryDataset` ([#6374](https://github.com/pyg-team/pytorch_geometric/pull/6374))
- Breaking Change: Changed the interface and implementation of `GraphMultisetTransformer` ([#6343](https://github.com/pyg-team/pytorch_geometric/pull/6343))
Expand Down
4 changes: 2 additions & 2 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* Monospace font in "Package Reference" navigation */
.wy-menu-vertical > ul:last-child li.toctree-l1 > a,
#pyg-documentation div.toctree-wrapper:last-child ul {
.wy-menu-vertical > ul:nth-child(10) li.toctree-l1 > a,
#pyg-documentation div.toctree-wrapper:nth-child(9) ul {
font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;
}

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
63 changes: 43 additions & 20 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,39 @@ In addition, it consists of easy-to-use mini-batch loaders for operating on many
.. slack::

.. toctree::
:glob:
:maxdepth: 1
:caption: Notes

notes/installation
notes/introduction
notes/create_gnn
notes/create_dataset
notes/heterogeneous
notes/load_csv
notes/graphgym
notes/batching
notes/sparse_tensor
notes/jit
notes/remote
notes/explain
notes/cheatsheet
notes/data_cheatsheet
notes/colabs
notes/resources
:caption: Install PyG

install/installation

.. toctree::
:maxdepth: 1
:caption: Get Started

get_started/introduction
get_started/colabs

.. toctree::
:maxdepth: 1
:caption: Tutorials

tutorial/create_gnn
tutorial/create_dataset
tutorial/heterogeneous
tutorial/load_csv
tutorial/explain

.. toctree::
:maxdepth: 1
:caption: Advanced Concepts

advanced/batching
advanced/sparse_tensor
advanced/jit
advanced/remote
advanced/graphgym

.. toctree::
:glob:
:maxdepth: 1
:caption: Package Reference

Expand All @@ -48,3 +58,16 @@ In addition, it consists of easy-to-use mini-batch loaders for operating on many
modules/graphgym
modules/explain
modules/profile

.. toctree::
:maxdepth: 1
:caption: Cheatsheets

cheatsheet/gnn_cheatsheet
cheatsheet/data_cheatsheet

.. toctree::
:maxdepth: 1
:caption: External Resources

external/resources
File renamed without changes.
File renamed without changes.