openrocket/docs/source/index.rst

61 lines
1.4 KiB
ReStructuredText
Raw Normal View History

2024-05-10 05:05:42 +02:00
.. OpenRocket documentation master file, created by
sphinx-quickstart on Tue Jan 2 22:06:21 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to OpenRocket's documentation!
======================================
**OpenRocket** is a free, fully featured model rocket simulator that allows you to design and simulate your rockets before building and flying them.
.. note::
This documentation is under active development.
.. toctree::
:maxdepth: 1
:caption: Introduction
introduction/overview
introduction/features
introduction/contribute
introduction/FAQ
.. toctree::
:maxdepth: 1
:caption: Setup
setup/installation
setup/getting_started
.. toctree::
:maxdepth: 1
:caption: User Guide
user_guide/basic_rocket_design
user_guide/thrust_curves
.. toctree::
:maxdepth: 1
:caption: Developer Guide
dev_guide/development_overview
dev_guide/development_setup
/dev_guide/architecture
/dev_guide/codebase_walkthrough
/dev_guide/development_guidelines
/dev_guide/testing_and_debugging
/dev_guide/api_documentation
/dev_guide/building_releasing
2024-05-10 05:50:55 +02:00
/dev_guide/contributing_to_translations
/dev_guide/contributing_to_the_docs
2024-05-10 05:05:42 +02:00
/dev_guide/contributing_to_the_website
/dev_guide/faq_troubleshooting
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`