bug fixes [makedocs]

ActivitySim · Nov 7, 2023 · ac5ca47 · ac5ca47
1 parent 86c3820
commit ac5ca47
Show file tree

Hide file tree

Showing 21 changed files with 22 additions and 44 deletions.
diff --git a/docs/dev-guide/components/accessibility.md b/docs/dev-guide/components/accessibility.md
@@ -65,5 +65,5 @@ function.  This function is registered as an Inject step in the example Pipeline
 ## Implementation
 
 ```{eval-rst}
-.. autofunction:: accessibility
+.. autofunction:: compute_accessibility
 ```
diff --git a/docs/dev-guide/components/atwork_subtour_destination.md b/docs/dev-guide/components/atwork_subtour_destination.md
@@ -2,7 +2,7 @@
 # At-work Subtours Destination Choice
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.atwork_subtour_destination.py
+.. currentmodule:: activitysim.abm.models.atwork_subtour_destination
 ```
 
 The at-work subtours destination choice model is made up of three model steps:

diff --git a/docs/dev-guide/components/atwork_subtour_frequency.md b/docs/dev-guide/components/atwork_subtour_frequency.md
@@ -2,7 +2,7 @@
 # At-work Subtours Frequency
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.atwork_subtour_frequency.py
+.. currentmodule:: activitysim.abm.models.atwork_subtour_frequency
 ```
 
 The at-work subtour frequency model selects the number of at-work subtours made for each work tour.

diff --git a/docs/dev-guide/components/atwork_subtour_mode_choice.md b/docs/dev-guide/components/atwork_subtour_mode_choice.md
@@ -2,7 +2,7 @@
 # At-work Subtour Mode
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.atwork_subtour_mode_choice.py
+.. currentmodule:: activitysim.abm.models.atwork_subtour_mode_choice
 ```
 
 The at-work subtour mode choice model assigns a travel mode to each at-work subtour using the `tour_mode_choice` model.

diff --git a/docs/dev-guide/components/atwork_subtour_scheduling.md b/docs/dev-guide/components/atwork_subtour_scheduling.md
@@ -2,7 +2,7 @@
 # At-work Subtour Scheduling
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.atwork_subtour_scheduling.py
+.. currentmodule:: activitysim.abm.models.atwork_subtour_scheduling
 ```
 
 The at-work subtours scheduling model selects a tour departure and duration period (and therefore a start and end

diff --git a/docs/dev-guide/components/auto_ownership.md b/docs/dev-guide/components/auto_ownership.md
@@ -19,7 +19,7 @@ This model is typically structured as multinomial logit model.
 ## Configuration
 
 ```{eval-rst}
-.. autopydantic_model::
+.. autopydantic_model:: AutoOwnershipSettings
     :inherited-members: BaseModel, PydanticReadable
     :show-inheritance:
 ```
@@ -32,5 +32,5 @@ This model is typically structured as multinomial logit model.
 ## Implementation
 
 ```{eval-rst}
-.. autofunction:: auto_ownership
+.. autofunction:: auto_ownership_simulate
 ```
diff --git a/docs/dev-guide/components/initialize.md b/docs/dev-guide/components/initialize.md
@@ -1,5 +1,5 @@
 (component-initialize)=
-# Initialize 
+# Initialize
 
 ```{eval-rst}
 .. currentmodule:: activitysim.abm.models.initialize
@@ -20,5 +20,6 @@ function.  These functions are registered as Inject steps in the example Pipelin
 ## Implementation
 
 ```{eval-rst}
-.. autofunction:: initialize
+.. autofunction:: initialize_landuse
+.. autofunction:: initialize_households
 ```
diff --git a/docs/dev-guide/components/joint_tour_destination.md b/docs/dev-guide/components/joint_tour_destination.md
@@ -43,7 +43,7 @@ to write logsums for estimation.
 ## Configuration
 
 ```{eval-rst}
-.. autopydantic_model:: JointTourDestinationSettings
+.. autopydantic_model:: TourLocationComponentSettings
     :inherited-members: BaseModel, PydanticReadable
     :show-inheritance:
 ```

diff --git a/docs/dev-guide/components/mandatory_scheduling.md b/docs/dev-guide/components/mandatory_scheduling.md
@@ -39,15 +39,6 @@ function.  This function is registered as an Inject step in the example Pipeline
 This model generates only True or False outcomes, and is structured as a binary
 logit model.
 
-
-## Configuration
-
-```{eval-rst}
-.. autopydantic_model:: MandatoryTourSchedulingSettings
-    :inherited-members: BaseModel, PydanticReadable
-    :show-inheritance:
-```
-
 ### Examples
 
 - [Prototype MTC](https://github.com/ActivitySim/activitysim/blob/main/activitysim/examples/prototype_mtc/configs/mandatory_tour_scheduling.yaml)

diff --git a/docs/dev-guide/components/non_mandatory_destination.md b/docs/dev-guide/components/non_mandatory_destination.md
@@ -26,7 +26,7 @@ for how to write logsums for estimation.
 ## Configuration
 
 ```{eval-rst}
-.. autopydantic_model:: NonMandatoryDestinationSettings
+.. autopydantic_model:: TourLocationComponentSettings
     :inherited-members: BaseModel, PydanticReadable
     :show-inheritance:
 ```

diff --git a/docs/dev-guide/components/non_mandatory_scheduling.md b/docs/dev-guide/components/non_mandatory_scheduling.md
@@ -19,16 +19,6 @@ function.  This function is registered as an Inject step in the example Pipeline
 - *Result Field*: `start, end, duration`
 - *Skims Keys*: `TAZ, destination, MD time period, MD time period`
 
-
-
-## Configuration
-
-```{eval-rst}
-.. autopydantic_model:: NonMandatorySchedulingSettings
-    :inherited-members: BaseModel, PydanticReadable
-    :show-inheritance:
-```
-
 ### Examples
 
 - [Prototype ARC](https://github.com/ActivitySim/activitysim/blob/main/activitysim/examples/prototype_arc/configs/non_mandatory_tour_scheduling.yaml)

diff --git a/docs/dev-guide/components/school_location_choice.md b/docs/dev-guide/components/school_location_choice.md
@@ -38,8 +38,6 @@ This function is registered as an Inject step in the example Pipeline. [writing_
 
 ```{eval-rst}
 .. autopydantic_model:: TourLocationComponentSettings
-    :inherited-members: BaseModel, PydanticReadable
-    :show-inheritance:
 ```
 
 ### Examples
@@ -51,5 +49,5 @@ This function is registered as an Inject step in the example Pipeline. [writing_
 ## Implementation
 
 ```{eval-rst}
-.. autofunction:: location_choice
+.. autofunction:: school_location
 ```
diff --git a/docs/dev-guide/components/stop_frequency.md b/docs/dev-guide/components/stop_frequency.md
@@ -2,7 +2,7 @@
 # Stop Frequency
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.stop_frequency.py
+.. currentmodule:: activitysim.abm.models.stop_frequency
 ```
 
 The stop frequency model assigns to each tour the number of intermediate destinations a person

diff --git a/docs/dev-guide/components/tour_mode_choice.md b/docs/dev-guide/components/tour_mode_choice.md
@@ -2,7 +2,7 @@
 # Tour Mode Choice
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.tour_mode_choice.py
+.. currentmodule:: activitysim.abm.models.tour_mode_choice
 ```
 
 The mandatory, non-mandatory, and joint tour mode choice model assigns to each tour the "primary" mode that

diff --git a/docs/dev-guide/components/trip_departure_choice.md b/docs/dev-guide/components/trip_departure_choice.md
@@ -2,7 +2,7 @@
 # Trip Departure Choice
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.trip_departure_choice.py
+.. currentmodule:: activitysim.abm.models.trip_departure_choice
 ```
 
 Used in conjuction with Trip Scheduling Choice (Logit Choice), this model chooses departure

diff --git a/docs/dev-guide/components/trip_mode_choice.md b/docs/dev-guide/components/trip_mode_choice.md
@@ -2,7 +2,7 @@
 # Trip Mode Choice
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.trip_mode_choice.py
+.. currentmodule:: activitysim.abm.models.trip_mode_choice
 ```
 
 The trip mode choice model assigns a travel mode for each trip on a given tour. It

diff --git a/docs/dev-guide/components/trip_purpose_and_destination.md b/docs/dev-guide/components/trip_purpose_and_destination.md
@@ -2,7 +2,7 @@
 # Trip Purpose and Destination
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.trip_purpose_and_destination.py
+.. currentmodule:: activitysim.abm.models.trip_purpose_and_destination
 ```
 
 After running trip purpose and trip destination separately, the two model can be ran together in an iterative fashion on

diff --git a/docs/dev-guide/components/trip_scheduling_choice.md b/docs/dev-guide/components/trip_scheduling_choice.md
@@ -2,7 +2,7 @@
 # Trip Scheduling Choice
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.trip_scheduling_choice.py
+.. currentmodule:: activitysim.abm.models.trip_scheduling_choice
 ```
 
 This model uses a logit-based formulation to determine potential trip windows for the three

diff --git a/docs/dev-guide/components/vehicle_allocation.md b/docs/dev-guide/components/vehicle_allocation.md
@@ -2,7 +2,7 @@
 # Vehicle Allocation
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.vehicle_allocation.py
+.. currentmodule:: activitysim.abm.models.vehicle_allocation
 ```
 
 The vehicle allocation model selects which vehicle would be used for a tour of given occupancy. The alternatives for the vehicle

diff --git a/docs/dev-guide/components/work_location_choice.md b/docs/dev-guide/components/work_location_choice.md
@@ -37,8 +37,6 @@ This function is registered as an Inject step in the example Pipeline.  See [wri
 
 ```{eval-rst}
 .. autopydantic_model:: TourLocationComponentSettings
-    :inherited-members: BaseModel, PydanticReadable
-    :show-inheritance:
 ```
 
 ### Examples
@@ -50,5 +48,5 @@ This function is registered as an Inject step in the example Pipeline.  See [wri
 ## Implementation
 
 ```{eval-rst}
-.. autofunction:: location_choice
+.. autofunction:: workplace_location
 ```
diff --git a/docs/dev-guide/components/write_trip_matrices.md b/docs/dev-guide/components/write_trip_matrices.md
@@ -2,7 +2,7 @@
 # Write Trip Matrices
 
 ```{eval-rst}
-.. currentmodule:: activitysim.abm.models.trip_matrices.py
+.. currentmodule:: activitysim.abm.models.trip_matrices
 ```
 
 Write open matrix (OMX) trip matrices for assignment.  Reads the trips table post preprocessor and run expressions