Skip to content

Commit

Permalink
documentation updates [makedocs]
Browse files Browse the repository at this point in the history
  • Loading branch information
vivekyadav26 committed Nov 9, 2023
1 parent ac5ca47 commit 529a4df
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/dev-guide/components/cdap.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ at [cdap](activitysim.abm.models.util.cdap) and contains CDAP model logic.
## Implementation

```{eval-rst}
.. autofunction:: cdap
.. autofunction:: cdap_simulate
```
2 changes: 2 additions & 0 deletions docs/dev-guide/components/initialize_los.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@ function. These functions are registered as Inject steps in the example Pipelin

```{eval-rst}
.. autofunction:: initialize_los
.. autofunction:: compute_utilities_for_attribute_tuple
.. autofunction:: initialize_tvpb
```
1 change: 1 addition & 0 deletions docs/dev-guide/components/joint_tour_participation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,5 @@ function. This function is registered as an Inject step in the example Pipeline

```{eval-rst}
.. autofunction:: joint_tour_participation
.. autofunction:: participants_chooser
```
1 change: 1 addition & 0 deletions docs/dev-guide/components/non_mandatory_tour_frequency.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,5 @@ function. This function is registered as an Inject step in the example Pipeline

```{eval-rst}
.. autofunction:: non_mandatory_tour_frequency
.. autofunction:: extend_tour_counts
```
2 changes: 2 additions & 0 deletions docs/dev-guide/components/parking_location_choice.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,6 @@ is registered as an Inject step, and it is available from the pipeline.

```{eval-rst}
.. autofunction:: parking_location
.. autofunction:: wrap_skims
.. autofunction:: parking_destination_simulate
```
6 changes: 5 additions & 1 deletion docs/dev-guide/components/tour_mode_choice.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,9 @@ See [writing_logsums](writing_logsums) for how to write logsums for estimation.
## Implementation

```{eval-rst}
.. autofunction:: tour_mode_choice
.. autofunction:: tour_mode_choice_simulate
.. autofunction:: create_logsum_trips
.. autofunction:: append_tour_leg_trip_mode_choice_logsums
.. autofunction:: get_trip_mc_logsums_for_all_modes
.. autofunction:: get_trip_mc_logsums_for_all_modes
```
4 changes: 3 additions & 1 deletion docs/dev-guide/components/trip_purpose.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Trip Purpose

```{eval-rst}
.. currentmodule:: activitysim.abm.models.trip_purpose.py
.. currentmodule:: activitysim.abm.models.trip_purpose
```

For trip other than the last trip outbound or inbound, assign a purpose based on an
Expand Down Expand Up @@ -41,4 +41,6 @@ Trip purpose and trip destination choice can be run iteratively together [trip_p

```{eval-rst}
.. autofunction:: trip_purpose
.. autofunction:: choose_intermediate_trip_purpose
.. autofunction:: run_trip_purpose
```
1 change: 0 additions & 1 deletion docs/dev-guide/components/trip_purpose_and_destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ function. This function is registered as an Inject step in the example Pipeline

## Structure


- *Core Table*: `trips`
- *Result Field*: `purpose, destination`
- *Skims Keys*: `origin, (tour primary) destination, dest_taz, trip_period`
Expand Down
6 changes: 6 additions & 0 deletions docs/dev-guide/components/trip_scheduling_choice.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,10 @@ main components of a tour.

```{eval-rst}
.. autofunction:: trip_scheduling_choice
.. autofunction:: generate_schedule_alternatives
.. autofunction:: no_stops_patterns
.. autofunction:: stop_one_way_only_patterns
.. autofunction:: stop_two_way_only_patterns
.. autofunction:: get_pattern_index_and_arrays
.. autofunction:: get_spec_for_segment
```
2 changes: 2 additions & 0 deletions docs/dev-guide/components/vehicle_allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,6 @@ selected vehicle to be used in two separate tours at the same time.

```{eval-rst}
.. autofunction:: vehicle_allocation
.. autofunction:: annotate_vehicle_allocation
.. autofunction:: get_skim_dict
```
8 changes: 8 additions & 0 deletions docs/dev-guide/components/vehicle_type_choice.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,12 @@ Further discussion of output results and model sensitivities can be found [here]

```{eval-rst}
.. autofunction:: vehicle_type_choice
.. autofunction:: append_probabilistic_vehtype_type_choices
.. autofunction:: annotate_vehicle_type_choice_households
.. autofunction:: annotate_vehicle_type_choice_persons
.. autofunction:: annotate_vehicle_type_choice_vehicles
.. autofunction:: get_combinatorial_vehicle_alternatives
.. autofunction:: construct_model_alternatives
.. autofunction:: get_vehicle_type_data
.. autofunction:: iterate_vehicle_type_choice
```

0 comments on commit 529a4df

Please sign in to comment.