Skip to content

Commit fcb3473

Browse files
committed
docs: updated cell.Tmp and data.mplot.Xs
1 parent 3e93e05 commit fcb3473

File tree

4 files changed

+34
-26
lines changed

4 files changed

+34
-26
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,17 @@ To run the PyMCNP test suite, after cloning the PyMCNP GitHub repository, use th
4848
# Running
4949
pytest --cov --cov-report term-missing:skip-covered
5050

51+
## Documenting
52+
53+
To rebuild the documentation using [Sphinx](https://www.sphinx-doc.org/en/master/) and [Napolean](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html):
54+
55+
# Installing
56+
pip install sphinx
57+
58+
# Running
59+
cd docs
60+
make html
61+
5162
## Copyright and License
5263

5364
For copyright and license information, see the `COPYRIGHT` and `LICENSE` files in the top level directory.

docs/source/pymcnp/inp/cell.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,6 @@
128128
:members:
129129
```
130130

131-
### ``Tmp`` Class
132-
133-
```{eval-rst}
134-
.. autoclass:: pymcnp.inp.cell.Tmp
135-
:members:
136-
```
137-
138131
### ``Tmp_0`` Class
139132

140133
```{eval-rst}
@@ -347,13 +340,6 @@
347340
:members:
348341
```
349342

350-
### ``TmpBuilder`` Class
351-
352-
```{eval-rst}
353-
.. autoclass:: pymcnp.inp.cell.TmpBuilder
354-
:members:
355-
```
356-
357343
### ``TmpBuilder_0`` Class
358344

359345
```{eval-rst}

docs/source/pymcnp/inp/data.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
data/ksen
2020
data/m_0
2121
data/mesh
22+
data/mplot
2223
data/pert
2324
data/ptrac
2425
data/rand

docs/source/pymcnp/inp/data/mplot.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# ``pymcnp.inp.data.mplot`` Subpackage
22

3+
## Table of Contents
4+
5+
```{eval-rst}
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
mplot/free
10+
mplot/contour
11+
```
12+
313
## AST Classes
414

515
### ``Bar`` Class
@@ -401,24 +411,24 @@
401411
:members:
402412
```
403413

404-
### ``XsBu`` Class
414+
### ``Xs_0`` Class
405415

406416
```{eval-rst}
407-
.. autoclass:: pymcnp.inp.data.mplot.XsBu
417+
.. autoclass:: pymcnp.inp.data.mplot.Xs_0
408418
:members:
409419
```
410420

411-
### ``XsBu`` Class
421+
### ``Xs_1`` Class
412422

413423
```{eval-rst}
414-
.. autoclass:: pymcnp.inp.data.mplot.XsBu
424+
.. autoclass:: pymcnp.inp.data.mplot.Xs_1
415425
:members:
416426
```
417427

418-
### ``XsBu`` Class
428+
### ``Xs_2`` Class
419429

420430
```{eval-rst}
421-
.. autoclass:: pymcnp.inp.data.mplot.XsBu
431+
.. autoclass:: pymcnp.inp.data.mplot.Xs_2
422432
:members:
423433
```
424434

@@ -858,24 +868,24 @@
858868
:members:
859869
```
860870

861-
### ``XsBuBuilder`` Class
871+
### ``XsBuilder_0`` Class
862872

863873
```{eval-rst}
864-
.. autoclass:: pymcnp.inp.data.mplot.XsBuBuilder
874+
.. autoclass:: pymcnp.inp.data.mplot.XsBuilder_0
865875
:members:
866876
```
867877

868-
### ``XsBuBuilder`` Class
878+
### ``XsBuilder_1`` Class
869879

870880
```{eval-rst}
871-
.. autoclass:: pymcnp.inp.data.mplot.XsBuBuilder
881+
.. autoclass:: pymcnp.inp.data.mplot.XsBuilder_1
872882
:members:
873883
```
874884

875-
### ``XsBuBuilder`` Class
885+
### ``XsBuilder_2`` Class
876886

877887
```{eval-rst}
878-
.. autoclass:: pymcnp.inp.data.mplot.XsBuBuilder
888+
.. autoclass:: pymcnp.inp.data.mplot.XsBuilder_2
879889
:members:
880890
```
881891

0 commit comments

Comments
 (0)