Skip to content

Commit

Permalink
DOC: fix doc build, and kill project build if it fails again
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Kienzle committed Nov 4, 2020
1 parent 2cfd088 commit 21c64ae
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
8 changes: 5 additions & 3 deletions doc/sphinx/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -m sphinx
PYTHON ?= python
SPHINXOPTS = -W --keep-going -n
SPHINXBUILD = $(PYTHON) -m sphinx
PAPER =
BUILDDIR = _build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest build

Expand Down
5 changes: 5 additions & 0 deletions doc/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@
# MathJax CDN is discontinued
mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML"

nitpick_ignore = [
('py:class', 'type'),
('py:class', 'object'),
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down
7 changes: 4 additions & 3 deletions periodictable/activation.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,9 @@ class Sample(object):
*formula* : chemical formula
Chemical formula. Any format accepted by :func:`periodictable.formula` can be
used, including formula string.
Chemical formula. Any format accepted by
:func:`.formulas.formula` can be used, including
formula string.
*mass* : float | g
Expand Down Expand Up @@ -150,7 +151,7 @@ def calculate_activation(self, environment, exposure=1,
*abundance* is a function that returns the relative abundance of an isotope. By
default it uses :func:`NIST2001_isotopic_abundance`, and there is the alternative
:func:`IAEA273_isotopic_abundance`.
:func:`IAEA1987_isotopic_abundance`.
"""
self.activity = {}
self.environment = environment
Expand Down

0 comments on commit 21c64ae

Please sign in to comment.