Skip to content

Commit

Permalink
documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
jrkerns committed Nov 10, 2017
1 parent d356074 commit e6da31d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
5 changes: 3 additions & 2 deletions docs/source/cbct_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ The CatPhan classes uses several other classes. There are several Slices of Inte
.. autoclass:: pylinac.ct.CatPhanBase

Module classes (CTP404, etc)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: pylinac.ct.Slice

Expand All @@ -263,6 +264,7 @@ Module classes (CTP404, etc)


ROI Objects
^^^^^^^^^^^

.. autoclass:: pylinac.ct.ROIManagerMixin

Expand All @@ -275,7 +277,6 @@ ROI Objects
.. autoclass:: pylinac.ct.GeometricLine

Helper Functions
^^^^^^^^^^^^^^^^

.. autofunction:: combine_surrounding_slices

.. autofunction:: get_catphan_classifier
1 change: 1 addition & 0 deletions docs/source/planar_imaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ The minimum needed to get going is to:
The figure can also be saved::

qc3.save_analyzed_image('myqc3.png')

A PDF report can also be generated::

qc3.publish_pdf('myqc3-june.pdf')
Expand Down
2 changes: 1 addition & 1 deletion docs/source/watcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Or
import pylinac
pylinac.watcher.watch("dir/to/watch", config_file="my/config.yaml")
pylinac.watch("dir/to/watch", config_file="my/config.yaml")
The YAML configuration file is the way to change keywords, set up a default analysis directory,
change analysis settings, and set up email service.
Expand Down

0 comments on commit e6da31d

Please sign in to comment.