Skip to content

Commit

Permalink
Fix sphinx-build warnings (#341)
Browse files Browse the repository at this point in the history
Increase title underline and switch to relative paths to fix a few sphinx-build warnings
  • Loading branch information
codecubepi authored Apr 2, 2024
1 parent 8b489a2 commit 5eeb1e5
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/getting_started/pre_reqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ examples provided within the ``examples`` folder to confirm everything is workin


More Information on Using Virtual Environments with Python (Approach 1)
----------------------------------------------------
------------------------------------------------------------------------

This section has been added to help approach 1 users be more "Python savvy". This section gives an overview of Python virtual
environments and provides necessary links to enable users to work with virtual environments using VS code.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/mach_eval_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ explained. These classes act an extension of the ``mach_opt`` module's ``Designe
purpose of this extension, is to provide a stronger framework for the flow of information between multiple evaluation steps (i.e.
an interdependent multiphysics machine design). These classes are constructed specifically for the design and evaluation of
electric machine, however they can be utilized in the optimization of any complex design problem. An example optimization
demonstrating the use of the ``mach_eval`` module is provided :doc:`in this document</getting_started/tutorials/analytical_machine_des_tutorial/index>`.
demonstrating the use of the ``mach_eval`` module is provided :doc:`in this document<../getting_started/tutorials/analytical_machine_des_tutorial/index>`.

MachineDesigner
****************
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/mach_opt_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ DesignSpace
DataHandler
Saves the design, evaluation results, and objective values so that optimization can be paused and resumed.

Additional details of each of these objects can be found in the code documentation. An example optimization of a rectangle using the ``mach_opt`` module can be found :doc:`here </getting_started/tutorials/rectangle_tutorial/index>`.
Additional details of each of these objects can be found in the code documentation. An example optimization of a rectangle using the ``mach_opt`` module can be found :doc:`here <../getting_started/tutorials/rectangle_tutorial/index>`.

Designer
****************
Expand Down

0 comments on commit 5eeb1e5

Please sign in to comment.