Skip to content

Commit

Permalink
Cleaner warning display in CircleCI (#570)
Browse files Browse the repository at this point in the history
* Split standard output and standard error of CircleCI doc build

Update astropy_helpers to remove a few warnings
Remove 'macros' from circleci
  • Loading branch information
StanczakDominik committed Oct 23, 2018
1 parent 8e0ab78 commit a752c0b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 18 deletions.
44 changes: 27 additions & 17 deletions .circleci/config.yml
@@ -1,32 +1,42 @@
deps-run: &deps-install
name: Install Python dependencies and PlasmaPy
command: |
pip install --user -r requirements/automated-documentation-tests.txt | cat
pip install --user . | cat
html-run: &doc-html
name: Build HTML documentation
command: python setup.py build_docs -w

latex-run: &doc-latex
name: Build LaTeX documentation
command: python setup.py build_docs -b latex -w

version: 2
jobs:
test-html:
docker:
- image: plasmapy/documentation-builder:latest
steps:
- checkout
- run: *deps-install
- run: *doc-html
- run:
name: Install Python dependencies and PlasmaPy
command: |
pip install --user -r requirements/automated-documentation-tests.txt | cat
pip install --user . | cat
- run:
name: Build HTML documentation
shell: /bin/bash
# command needed to not fail the build step on non-zero exit code from sphinx
# (now is not the time for build fail)
# (that comes later)
command: |
# build docs, sending standard output and error to separate files in /tmp
# || true ignores the error code as stated above
# echo | tee prints out sphinx's error code and saves it to /tmp
python setup.py build_docs -W 2> >(tee /tmp/stderr) 1> >(tee /tmp/stdout) || true; echo $? | tee /tmp/EXITCODE
- store_artifacts:
path: docs/_build/html
- run:
name: "Built documentation is available at:"
command: DOCS_URL="${CIRCLE_BUILD_URL}/artifacts/${CIRCLE_NODE_INDEX}/${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}/docs/_build/html/index.html"; echo $DOCS_URL
- run: *doc-latex
- run:
name: "Output from html documentation build is:"
command: cat /tmp/stdout
- run:
name: "Error from html documentation build is:"
# display stderr from build AND assert the build went successfully
# build errors should fail at this stage
command: cat /tmp/stderr && [ $(cat /tmp/EXITCODE) -eq 0 ]
- run:
name: Build LaTeX documentation
command: python setup.py build_docs -b latex -w

workflows:
version: 2
Expand Down
2 changes: 1 addition & 1 deletion astropy_helpers
Submodule astropy_helpers updated 56 files
+11 −9 .travis.yml
+20 −10 CHANGES.rst
+0 −1 MANIFEST.in
+17 −0 README.rst
+14 −28 ah_bootstrap.py
+2 −3 appveyor.yml
+1 −28 astropy_helpers/commands/build_sphinx.py
+0 −12 astropy_helpers/compat/__init__.py
+11 −0 astropy_helpers/extern/__init__.py
+1 −0 astropy_helpers/extern/automodapi/__init__.py
+135 −0 astropy_helpers/extern/automodapi/autodoc_enhancements.py
+423 −0 astropy_helpers/extern/automodapi/automodapi.py
+664 −0 astropy_helpers/extern/automodapi/automodsumm.py
+92 −0 astropy_helpers/extern/automodapi/smart_resolver.py
+10 −0 astropy_helpers/extern/automodapi/templates/autosummary_core/base.rst
+65 −0 astropy_helpers/extern/automodapi/templates/autosummary_core/class.rst
+41 −0 astropy_helpers/extern/automodapi/templates/autosummary_core/module.rst
+214 −0 astropy_helpers/extern/automodapi/utils.py
+5 −0 astropy_helpers/extern/numpydoc/__init__.py
+603 −0 astropy_helpers/extern/numpydoc/docscrape.py
+309 −0 astropy_helpers/extern/numpydoc/docscrape_sphinx.py
+271 −0 astropy_helpers/extern/numpydoc/numpydoc.py
+16 −0 astropy_helpers/extern/numpydoc/templates/numpydoc_docstring.rst
+4 −0 astropy_helpers/extern/setup_package.py
+1 −1 astropy_helpers/setup_helpers.py
+8 −0 astropy_helpers/sphinx/__init__.py
+332 −2 astropy_helpers/sphinx/conf.py
+2 −0 astropy_helpers/sphinx/ext/__init__.py
+82 −0 astropy_helpers/sphinx/ext/changelog_links.py
+56 −0 astropy_helpers/sphinx/ext/doctest.py
+168 −0 astropy_helpers/sphinx/ext/edit_on_github.py
+0 −0 astropy_helpers/sphinx/ext/tests/__init__.py
+22 −0 astropy_helpers/sphinx/ext/tocdepthfix.py
+ astropy_helpers/sphinx/local/python3_local_links.inv
+38 −0 astropy_helpers/sphinx/local/python3_local_links.txt
+10 −0 astropy_helpers/sphinx/setup_package.py
+3 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/globaltoc.html
+96 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/layout.html
+3 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/localtoc.html
+7 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/searchbox.html
+75 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/static/astropy_linkout.svg
+ astropy_helpers/sphinx/themes/bootstrap-astropy/static/astropy_linkout_20.png
+ astropy_helpers/sphinx/themes/bootstrap-astropy/static/astropy_logo.ico
+87 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/static/astropy_logo.svg
+ astropy_helpers/sphinx/themes/bootstrap-astropy/static/astropy_logo_32.png
+601 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/static/bootstrap-astropy.css
+63 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/static/copybutton.js
+160 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/static/sidebar.js
+10 −0 astropy_helpers/sphinx/themes/bootstrap-astropy/theme.conf
+13 −0 astropy_helpers/test_helpers.py
+9 −5 astropy_helpers/tests/test_setup_helpers.py
+9 −1 astropy_helpers/version_helpers.py
+0 −414 ez_setup.py
+50 −0 licenses/LICENSE_COPYBUTTON.rst
+94 −0 licenses/LICENSE_NUMPYDOC.rst
+5 −3 setup.py

0 comments on commit a752c0b

Please sign in to comment.