Skip to content

Commit

Permalink
Rename in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Huowl committed Oct 17, 2023
1 parent 44c4d36 commit cc9684f
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 20 deletions.
11 changes: 6 additions & 5 deletions docs/source/modules/block_builder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,23 @@
Block builder
=============

Block render
Block blueprints
============

.. automodule:: rostok.block_builder.node_render
.. automodule:: rostok.block_builder_api.block_blueprint
:members:
:undoc-members:

Control
Block parameters
=======

.. automodule:: rostok.block_builder.control
.. automodule:: rostok.block_builder_api.block_parameter
:members:
:undoc-members:

Shapes
======

.. automodule:: rostok.block_builder.envbody_shapes
.. automodule:: rostok.block_builder_api.easy_body_shapes
:members:
:undoc-members:
4 changes: 2 additions & 2 deletions docs/source/modules/criterion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Criterion
Criterion calculation
=====================

.. automodule:: rostok.criterion.criterion_calc
.. automodule:: rostok.criterion.criterion_calculation
:members:

Flag stop simulation
====================

.. automodule:: rostok.criterion.flags_simualtions
.. automodule:: rostok.criterion.simulation_flag
:members:
22 changes: 19 additions & 3 deletions docs/source/modules/graph_generators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,25 @@
Graph generation
================

Graph environments
Design environment
==================

.. automodule:: rostok.graph_generators.graph_environment
.. automodule:: rostok.graph_generators.environment.design_environment
:members:
:undoc-members:
:undoc-members:

MCTS
==================

.. audomodule:: rostok.graph_generators.search_algorithms.mcts
:members:
:undoc-members:


MCTS Manager
==================

.. automodule:: rostok.graph_generators.mcts_manager
:members:
:undoc-members:

9 changes: 2 additions & 7 deletions docs/source/modules/graph_grammar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Node
.. automodule:: rostok.graph_grammar.node
:members:

Nodes division
Graph-grammar explorer
==============

.. automodule:: rostok.graph_grammar.nodes_division
.. automodule:: rostok.graph_grammar.graphgrammar_explorer
:members:

Node Vocabulary
Expand All @@ -26,11 +26,6 @@ Rule Vocabulary
.. automodule:: rostok.graph_grammar.rule_vocabulary
:members:

Graph grammar explorer
======================

.. automodule:: rostok.graph_grammar.graphgrammar_explorer
:members:

Random graph
============
Expand Down
1 change: 1 addition & 0 deletions docs/source/modules/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ That is about modules into rostok
graph_generators
criterion
trajectory_optimizer
simulation_chrono
virtual_experiment
utils

Expand Down
21 changes: 21 additions & 0 deletions docs/source/modules/simulation_chrono.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
==================
Simulation in ProjectChrono
==================

Simulation scenario
===============

.. automodule:: rostok.simulation_chrono.simulation_scenario
:members:

Simulation
==================

.. automodule:: rostok.simulation_chrono.simulation
:members:

Simulation utils
==================

.. automodule:: rostok.simulation_chrono.simulation_utils
:members:
6 changes: 3 additions & 3 deletions docs/source/modules/virtual_experiment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
Virtual experiment
==================

Simulation step
Robot
===============

.. automodule:: rostok.virtual_experiment.simulation_step
.. automodule:: rostok.virtual_experiment.robot_new
:members:

Auxilarity sensors
==================

.. automodule:: rostok.virtual_experiment.auxilarity_sensors
.. automodule:: rostok.virtual_experiment.sensors
:members:

0 comments on commit cc9684f

Please sign in to comment.