Skip to content

Commit

Permalink
Messed with API TOC to make it actually legible.
Browse files Browse the repository at this point in the history
  • Loading branch information
MicahGale committed Mar 9, 2024
1 parent 4221b46 commit 70a20df
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 14 deletions.
36 changes: 32 additions & 4 deletions doc/source/api/modules.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,36 @@
Python API
============
MontePy API
===========

Submodules
----------

.. toctree::
:maxdepth: 4
:maxdepth: 1

montepy.cell
montepy.cells
montepy.constants
montepy.errors
montepy.geometry_operators
montepy.materials
montepy.mcnp_object
montepy.mcnp_problem
montepy.numbered_mcnp_object
montepy.numbered_object_collection
montepy.particle
montepy.surface_collection
montepy.transforms
montepy.universe
montepy.universes
montepy.utilities

Subpackages
-----------

.. toctree::
:maxdepth: 2

montepy.data_inputs
montepy.input_parser
montepy.surfaces

montepy
2 changes: 1 addition & 1 deletion doc/source/api/montepy.cell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ montepy.cell module
===================


.. automodule:: montepy.cell
.. autoclass:: montepy.cell.Cell
:members:
:undoc-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions doc/source/api/montepy.data_inputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ montepy.data\_inputs package
:undoc-members:
:show-inheritance:

Submodules
----------

.. toctree::
:maxdepth: 4
Expand Down
5 changes: 1 addition & 4 deletions doc/source/api/montepy.input_parser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,8 @@ montepy.input\_parser package
:undoc-members:
:show-inheritance:

Submodules
----------

.. toctree::
:maxdepth: 4
:maxdepth: 2

montepy.input_parser.block_type
montepy.input_parser.cell_parser
Expand Down
4 changes: 1 addition & 3 deletions doc/source/api/montepy.surfaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ montepy.surfaces package
:undoc-members:
:show-inheritance:

Submodules
----------

.. toctree::
:maxdepth: 4
:maxdepth: 2

montepy.surfaces.axis_plane
montepy.surfaces.cylinder_on_axis
Expand Down

0 comments on commit 70a20df

Please sign in to comment.