[doc] start sphynx doc for paparazzi (#2247)

This commit is contained in:
Gautier Hattenberger
2018-03-30 22:27:13 +02:00
committed by GitHub
parent be41080a99
commit b8b8000eb8
54 changed files with 1148 additions and 0 deletions
+225
View File
@@ -0,0 +1,225 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PaparazziUAV.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PaparazziUAV.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PaparazziUAV"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PaparazziUAV"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."
+337
View File
@@ -0,0 +1,337 @@
# -*- coding: utf-8 -*-
#
# PaparazziUAV documentation build configuration file, created by
# sphinx-quickstart on Mon Jan 15 10:50:28 2018.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'PaparazziUAV'
copyright = u'2018, Paparazzi UAV Team'
author = u'Paparazzi UAV Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'5.13'
# The full version, including alpha/beta/rc tags.
release = u'_devel'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = u'PaparazziUAV vmaster'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'PaparazziUAVdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'PaparazziUAV.tex', u'PaparazziUAV Documentation',
u'Paparazzi UAV Team', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'paparazziuav', u'PaparazziUAV Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'PaparazziUAV', u'PaparazziUAV Documentation',
author, 'PaparazziUAV', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False
@@ -0,0 +1,9 @@
.. developer_guide dev_second developer2
======================
Developer 2
======================
TBD
@@ -0,0 +1,14 @@
.. developer_guide main_developer index_developer
=================
Developer Guide
=================
TBD
.. toctree::
:maxdepth: 2
system_overview
developer2
@@ -0,0 +1,9 @@
.. developer_guide dev_first system_overview
======================
Detailed System Overview
======================
TBD
+69
View File
@@ -0,0 +1,69 @@
.. PaparazziUAV documentation master file, created by
sphinx-quickstart on Mon Jan 15 10:50:28 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. image:: ../../../data/pictures/Penguin.gif
:align: center
:width: 50%
|
|
.. Welcome to PaparazziUAV's documentation!
========================================
**Paparazzi UAV** (Unmanned Aerial Vehicle) is an open-source drone hardware and software project encompassing autopilot systems and ground station software for multicopters/multirotors, fixed-wing, helicopters and hybrid aircraft that was founded in **2003**.
Paparazzi UAV was designed with autonomous flight as the primary focus and manual flying as the secondary. From the beginning it was designed with portability in mind and the ability to control multiple aircraft within the same system.
Paparazzi features a dynamic flight plan system that is defined by mission states and using way points as “variables”. This makes it easy to create very complex fully automated missions without the operators intervention.
.. tip::
Keep up with the latest news on `Paparazzi Blog! <http://blog.paparazziuav.org/>`__
Contents:
.. toctree::
:maxdepth: 2
quickstart/index_start
tutorials/index_tutorials
installation/index_installation
user_guide/index_user_guide
developer_guide/index_developer
support/index_support
--------------
Community
=========
`Discussion forum on Gitter <http://gitter.im/paparazzi/discuss>`__
Developer Community
===================
`Legacy Wiki documentation <http://wiki.paparazziuav.org/wiki/Main_Page>`__
History
=======
TBD
--------------
Features
========
TBD
--------------
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@@ -0,0 +1,7 @@
.. installation hardware_installation fixed_wing
======================
Fixed-Wing
======================
TBD
@@ -0,0 +1,13 @@
.. installation hardware_installation airframe airframes
======================
Airframes
======================
Airframes ...
.. toctree::
fixed_wing
rotorcraft
vtol
@@ -0,0 +1,7 @@
.. installation hardware_installation rotorcraft
======================
Rotorcraft
======================
TBD
@@ -0,0 +1,7 @@
.. installation hardware_installation vtol
======================
VTOL
======================
TBD
@@ -0,0 +1,7 @@
.. installation hardware_installation apogee
======================
Apogee
======================
TBD
@@ -0,0 +1,7 @@
.. installation hardware_installation chimera
======================
Chimera
======================
TBD
@@ -0,0 +1,14 @@
.. installation hardware_installation autopilot autopilots
======================
Autopilots
======================
Autopilots ...
.. toctree ::
apogee
chimera
@@ -0,0 +1,12 @@
.. installation main_installation hardware
======================
Hardware
======================
Hardware installation ...
.. toctree ::
airframes/index_airframes
autopilots/index_autopilots
@@ -0,0 +1,13 @@
.. installation main_installation index_installation
=================
Installation
=================
TBD
.. toctree::
:maxdepth: 2
software/index_software
hardware/index_hardware
@@ -0,0 +1,14 @@
.. installation main_installation software
======================
Software
======================
Software installation ...
.. toctree ::
:maxdepth: 2
linux
mac_os
windows
@@ -0,0 +1,7 @@
.. installation software_installation linux
======================
Linux
======================
TBD
@@ -0,0 +1,7 @@
.. installation software_installation mac_os
======================
MAC OS
======================
TBD
@@ -0,0 +1,7 @@
.. installation software_installation windows
======================
Windows
======================
TBD
@@ -0,0 +1,9 @@
.. quickstart main_quickstart first_flight
======================
Experimental Flight
======================
Flying a Bebop2 ...
@@ -0,0 +1,9 @@
.. quickstart main_quickstart first_simu
======================
Flight Simulation
======================
TBD
@@ -0,0 +1,14 @@
.. quickstart main_quickstart index_start
=================
QuickStart
=================
TBD
.. toctree::
:maxdepth: 3
install
first_simulation
first_flight
+9
View File
@@ -0,0 +1,9 @@
.. quickstart main_quickstart install
======================
Quick Install
======================
TBD
+7
View File
@@ -0,0 +1,7 @@
.. support main_support faq
======================
FAQ
======================
TBD
+7
View File
@@ -0,0 +1,7 @@
.. support main_support forum
======================
Forum
======================
TBD
@@ -0,0 +1,15 @@
.. support main_support index_support
=================
Support
=================
TBD
.. toctree::
:maxdepth: 3
wiki
faq
forum
+9
View File
@@ -0,0 +1,9 @@
.. support main_support wiki
======================
Wiki
======================
TBD
@@ -0,0 +1,9 @@
.. tutorials main_tutorials advanced
======================
Advanced
======================
TBD
@@ -0,0 +1,9 @@
.. tutorials main_tutorials beginner add_drones
=========================
Add Drones
=========================
TBD
@@ -0,0 +1,9 @@
.. tutorials main_tutorials beginner airframe_setup
======================
Airframe Setup
======================
TBD
@@ -0,0 +1,9 @@
.. tutorials main_tutorials beginner flight_plan
======================
Flight Plan Setup
======================
TBD
@@ -0,0 +1,9 @@
.. tutorials main_tutorials beginner gcs_setup
======================
GCS Setup
======================
TBD
@@ -0,0 +1,18 @@
.. tutorials main_tutorials beginner
======================
Beginner
======================
TBD
.. toctree ::
gcs_setup
airframe_setup
add_drones
flight_plan_setup
testing_and_tuning
sensor_calibration
@@ -0,0 +1,9 @@
.. tutorials main_tutorials beginner sensor_calibration
======================
Sensor Calibration
======================
TBD
@@ -0,0 +1,9 @@
.. tutorials main_tutorials beginner testing_and_tuning
======================
Testing and Tuning
======================
TBD
@@ -0,0 +1,15 @@
.. tutorials main_tutorials index_tutorials
=================
Tutorials
=================
TBD
.. toctree ::
beginner/index_beginner
intermediate/index_intermediate
advanced/index_advanced
@@ -0,0 +1,12 @@
.. tutorials main_tutorials intermediate
======================
Intermediate
======================
TBD
.. toctree ::
write_module
@@ -0,0 +1,9 @@
.. tutorials main_tutorials intermediate write_module
======================
Write a New Module
======================
TBD
@@ -0,0 +1,9 @@
.. user_guide main_user hardware airframes
======================
Airframes
======================
TBD
@@ -0,0 +1,9 @@
.. user_guide main_user hardware electronics
======================
Electronics
======================
TBD
@@ -0,0 +1,16 @@
.. user_guide main_user hardware
======================
Hardware
======================
TBD
.. toctree::
airframes
electronics
sensors
@@ -0,0 +1,9 @@
.. user_guide main_user hardware sensors
======================
Sensors
======================
TBD
@@ -0,0 +1,14 @@
.. user_guide main_user index_user
=================
User Guide
=================
TBD
.. toctree::
:maxdepth: 3
system_overview/system_overview
software/index_software
hardware/index_hardware
@@ -0,0 +1,9 @@
.. user_guide main_user software airframe_conf
======================
Airframe Configuration
======================
TBD
@@ -0,0 +1,9 @@
.. user_guide main_user software architecture
======================
Architecture
======================
TBD
@@ -0,0 +1,9 @@
.. user_guide main_user software flashing
======================
Flashing
======================
TBD
@@ -0,0 +1,9 @@
.. user_guide main_user software gcs
======================
Ground Control Station (GCS)
======================
TBD
@@ -0,0 +1,9 @@
.. user_guide main_user software help_software
======================
Helping Software
======================
TBD
@@ -0,0 +1,20 @@
.. user_guide main_user software
======================
Software
======================
TBD
.. toctree::
architecture
pprz_center
airframe_conf
gcs
simulation
flashing
tuning
logs
help_software
@@ -0,0 +1,9 @@
.. user_guide main_user software logs
======================
Logs
======================
TBD

Some files were not shown because too many files have changed in this diff Show More