Skip to content

Commit

Permalink
Merge pull request ActivitySim#523 from ActivitySim/develop
Browse files Browse the repository at this point in the history
rst doc fix
  • Loading branch information
bstabler authored Nov 10, 2021
2 parents 9eb78a9 + bf34f68 commit 670607f
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 6 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ jobs:

- stage: Deployment
name: Documentation
env: TEST_ENV="activitysim-test-larch"
script:
- coveralls
# Build docs
Expand Down
2 changes: 1 addition & 1 deletion docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ Generally speaking, there are two types of ActivitySim examples: test examples a
examples are :ref:`example_mtc`, :ref:`example_estimation`, :ref:`example_multiple_zones`, and :ref:`example_marin`.
These examples are owned and maintained by the project.
* Agency examples - these are agency partner model implementations currently being setup. The current agency examples
are :ref:`example_arc`, :ref:`example_semcog`, :ref:`example_psrc`, and :ref:`example_sandag`. These examples can be
are :ref:`example_arc`, :ref:`example_semcog`, :ref:`example_psrc`, :ref:`example_sandag`, and :ref:`example_sandag_xborder`. These examples can be
configured in ways different from the test examples, include new inputs and expressions, and may include new planned
software components for contribution to ActivitySim. These examples are owned by the agency.

Expand Down
6 changes: 3 additions & 3 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This page describes the example models included with ActivitySim. The current e
+---------------------------------+-----------------------------------------------------------+--------------+----------------------+
| :ref:`example_sandag` | SANDAG agency example | 3 | In development |
+---------------------------------+-----------------------------------------------------------+--------------+----------------------+
| :ref:`example_sandag_xborder` | SANDAG agency example | 3 | In development |
| :ref:`example_sandag_xborder` | SANDAG agency example | 3 | In development |
+---------------------------------+-----------------------------------------------------------+--------------+----------------------+

.. note::
Expand Down Expand Up @@ -1514,10 +1514,10 @@ Example
See example commands in `example_manifest.yaml <https://github.com/ActivitySim/activitysim/blob/master/activitysim/examples/example_manifest.yaml>`_
for running example_sandag. For optimal performance, configure multiprocessing and chunk_size based on machine hardware.

.. _example_sandag :
.. _example_sandag_xborder :

example_sandag_xborder
--------------
----------------------

.. note::

Expand Down
8 changes: 6 additions & 2 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,15 @@ tools for certain development tasks::
conda install jupyterlab matplotlib geopandas descartes -c conda-forge --override-channels -n asim

To create an environment containing all these optional dependencies at once, you
can run the shortcut command::
can run the shortcut command

::

conda env create activitysim/ASIM -n asim

4. To use the **asim** environment, you need to activate it::
4. To use the **asim** environment, you need to activate it

::

conda activate asim

Expand Down

0 comments on commit 670607f

Please sign in to comment.