Skip to content

Commit

Permalink
Merge pull request #527 from ActivitySim/develop
Browse files Browse the repository at this point in the history
fix rst file css template usage
  • Loading branch information
bstabler committed Nov 12, 2021
2 parents fc81e3e + c88298a commit 3df695b
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 95 deletions.
3 changes: 2 additions & 1 deletion .travis.yml
Expand Up @@ -46,7 +46,8 @@ jobs:
script:
- coveralls
# Build docs
- mamba install sphinx numpydoc sphinx_rtd_theme
- mamba install sphinx numpydoc
- conda install -c conda-forge sphinx_rtd_theme==0.5.2
- cd docs
- make clean
- make html
Expand Down
62 changes: 0 additions & 62 deletions bin/build_docs.sh

This file was deleted.

38 changes: 7 additions & 31 deletions docs/development.rst
Expand Up @@ -203,19 +203,12 @@ ActivitySim testing is done with three tools:
* `pytest <http://pytest.org/latest/>`__, a Python testing tool
* `coveralls <https://github.com/coagulant/coveralls-python>`__, a tool for measuring code coverage and publishing code coverage stats online

To run the tests locally, first make sure the required packages are installed:
To run the tests locally, first make sure the required packages are installed. Next, run the tests with the following commands:

::

pip install pytest pytest-cov coveralls pycodestyle

Next, run the tests with the following commands:

::

pycodestyle activitysim
py.test --cov activitysim --cov-report term-missing
pycodestyle
py.test

These same tests are run by Travis with each push to the repository. These tests need to pass in order
to merge the revisions into master.
Expand Down Expand Up @@ -247,29 +240,12 @@ them into html as well. ActivitySim's docstrings are written in `numpydoc forma
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`__ since it is easier to use
than standard rst format.

To build the documentation, first make sure the required packages are installed:

::

pip install sphinx numpydoc sphinx_rtd_theme

Next, build the documentation in html format with the following command run from the ``docs`` folder:

::

make html
To build the documentation, first make sure the required packages are installed. Next, build the
documentation in html format with the ``make html`` command run from the ``docs`` folder.

If the activitysim package is installed, then the documentation will be built from that version of
the source code instead of the git repo version. Make sure to ``pip uninstall activitysim`` before
building the documentation if needed.

When pushing revisions to the repo, the documentation is automatically built by Travis after
successfully passing the tests. The documents are built with the ``bin/build_docs.sh`` script.
The script does the following:

* installs the required python packages
* runs ``make html``
* copies the ``master`` branch ``../activitysim/docs/_build/html/*`` pages to the ``gh-pages`` branch
the source code instead of the git repo version. When pushing revisions to the repo, the documentation
is automatically built by Travis after successfully passing the tests.

GitHub automatically publishes the gh-pages branch at https://activitysim.github.io/activitysim.

Expand Down
2 changes: 1 addition & 1 deletion docs/gettingstarted.rst
Expand Up @@ -65,7 +65,7 @@ tools for certain development tasks::
conda install pytest pytest-cov coveralls pycodestyle pytest-regressions -c conda-forge --override-channels -n asim

# packages for building documentation
conda install sphinx numpydoc sphinx_rtd_theme -c conda-forge --override-channels -n asim
conda install sphinx numpydoc sphinx_rtd_theme==0.5.2 -c conda-forge --override-channels -n asim

# packages for estimation integration
conda install larch -c conda-forge --override-channels -n asim
Expand Down

0 comments on commit 3df695b

Please sign in to comment.