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.

Sign up for GitHub

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

Jump to bottom

DOC Use sphinx < 3.0 when building docs on readthedocs #399

Merged
merged 2 commits into from
Apr 21, 2020
Merged

DOC Use sphinx < 3.0 when building docs on readthedocs #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2308c90
DOC Use sphinx >=2, < 3 building docs
drewejohnson Apr 21, 2020
ad2ae67
DOC Remove some doc warnings: UnivTuple, glossary
drewejohnson Apr 21, 2020
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
2 changes: 1 addition & 1 deletion docs/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Glossary
:term:`Miniconda`. For more information, see
`<https://www.anaconda.com/>`_.

Anaconda prompt
Anaconda Prompt
Modified Windows prompt to be used with the :term:`Anaconda` python
distrubution. Reconfigures python paths to point to packages
installed via :term:`conda`
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sphinx>=2.0
sphinx>=2.0,<3.0
8 changes: 2 additions & 6 deletions serpentTools/objects/containers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,13 @@

UnivTuple = namedtuple("UnivTuple", ["universe", "burnup", "step", "days"])

try:
UnivTuple.__doc__ = """Convenient identifier for universes
UnivTuple.__doc__ = """Convenient identifier for universes

Properties can be accessed by position or by attribute name.
The latter is preferable as it will be consistent across
potential API changes

Attributes
Parameters
----------
universe : str
Universe from Serpent input
Expand All @@ -83,9 +82,6 @@
True

"""
except AttributeError:
# Can't set docs for namedtuples in PY2
pass


class HomogUniv(NamedObject):
Expand Down