début de la doc rst.

aklotz
1 parent 78557f8c
Showing 5 changed files with 526 additions and 0 deletions Show diff stats
doc/rst/conf.py
doc/rst/generate_documentation.rst
doc/rst/index.rst
doc/rst/make_doc.bat
doc/rst/pyros_configuration.rst
@@ -0,0 +1,375 @@
+# pyros documentation build configuration file, created by
+# sphinx-quickstart on Sun Jun 26 00:00:43 2016.
+#
+# 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 = []
+
+# 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'Python Robotic Observatory Software'
+copyright = u'2021, IRAP'
+author = u'E. Pallier, A. Koralewski, A. Klotz'
+
+# 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'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0.0'
+
+# 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.
+# These patterns also affect html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# 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 = False
+
+
+# -- 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 = 'alabaster'
+
+# 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'pyros vpyros'
+
+# 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
+
+# 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 = 'pyros'
+
+# -- 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, 'pyros.tex', u'pyros Documentation',
+     u'pyros', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# 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, 'pyros', u'pyros 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, 'pyros', u'pyros Documentation',
+     author, 'pyros', '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
+
+# -- A random example -----------------------------------------------------
+
+import sys, os
+sys.path.insert(0, os.path.abspath('..'))
+# exclude_patterns = ['zzz']
+
+numfig = True
+#language = 'ja'
+
+extensions.append('sphinx.ext.todo')
+extensions.append('sphinx.ext.autodoc')
+#extensions.append('sphinx.ext.autosummary')
+extensions.append('sphinx.ext.intersphinx')
+extensions.append('sphinx.ext.mathjax')
+extensions.append('sphinx.ext.viewcode')
+extensions.append('sphinx.ext.graphviz')
+try:
+    extensions.append('sphinx_pyreverse')
+except ModuleNotFoundError:
+    pass # pip install sphinx_pyreverse
+
+try:
+    import rst2pdf
+    extensions.append('rst2pdf.pdfbuilder')
+except ModuleNotFoundError:
+    pass # no rst2pdf for you
+
+extensions.append('sphinx.ext.napoleon')
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
+
+pdf_documents = [
+    ('index', u'Python Robotic Observatory Software', u'Python Robotic Observatory Software', u'Etienne Pallier, Alexis Koralewski, Alain Klotz'),
+]
+# A comma-separated list of custom stylesheets. Example:
+pdf_stylesheets = ['sphinx', 'kerning', 'a4']
+
+
+autosummary_generate = True
+html_theme = 'default'
+#html_theme = "nature"
+#source_suffix = ['.rst', '.txt']
 \ No newline at end of file
@@ -0,0 +1,78 @@
+********************************************
+Generate this documentation
+********************************************
+
+This documentation is generated by the use of Sphinx and Pyreverse.
+Sphinx uses the `Restructured Text format <https://en.wikipedia.org/wiki/ReStructuredText>`_.
+The following links gives some informations about the syntax:
+
+	* `Tutorial Sphinx 1 <https://deusyss.developpez.com/tutoriels/Python/SphinxDoc/>`_.
+	* `Tutorial Sphinx 2 <https://www.mankier.com/1/sphinx-all>`_.
+	* `Tutorial documentation <https://www.codeflow.site/fr/article/documenting-python-code>`_.
+	* `Tutorial reST <https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_.
+	* `Tutorial Napoleon extension <https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#module-sphinx.ext.napoleon>`_.
+
+Installation of Sphinx and Pyreverse
+***********************************************
+
+Procedure for Linux (root privileges):
+
+.. code-block:: bash
+
+	sudo pip3 install sphinx
+	sudo pip3 install rst2pdf
+	sudo pip3 install pylint
+	sudo pip3 install sphinx_pyreverse
+	sudo pip3 install graphviz
+	sudo apt-get install graphviz graphviz-dev
+	sudo pip3 install pygraphviz
+
+Procedure for Windows (user xxx). First you must download and install 
+`Graphviz <https://graphviz.org/>`_. Then:
+
+.. code-block:: bash
+
+	cd c:\Users\xxx\Anaconda3\Scripts
+	.\pip install -U Sphinx
+	.\pip install rst2pdf
+	.\conda install pyreverse
+	.\conda install python-graphviz	
+
+Generate the documentation
+***********************************************
+
+To generate the documentation you must start to execute pyreverse 
+followed by sphinx. 
+
+Procedure pyreverse for Linux:
+
+.. code-block:: bash
+
+	cd $PYROS
+	pyreverse3 -p pyros -o png ../../pyros
+	cp classes_*.png ../doc_images
+
+Procedure sphinx for Linux:
+	
+.. code-block:: bash
+
+	cd pyros/doc/rst
+	sphinx-build -b html . ./../doc_html
+	sphinx-build -b pdf . ./../doc_pdf
+
+Procedure pyreverse for Windows (user xxx):
+
+.. code-block:: bash
+
+	cd astromecca\doc_rst\doc_pyreverse
+	c:\Users\xxx\Anaconda3\Scripts\pyreverse -p pyros -o png ../../pyros
+	copy classes_*.png ..\..\doc_images
+
+Procedure sphinx for Windows (user xxx):
+
+.. code-block:: bash
+
+	cd astromecca\doc_rst
+	C:\Users\xxx\Anaconda3\Scripts\sphinx-build -b html . .\..\doc_html
+	C:\Users\xxx\Anaconda3\Scripts\sphinx-build -b pdf . .\..\doc_pdf
+
@@ -0,0 +1,55 @@
+*****************************************************
+Welcome in the PyROS developer documentation
+*****************************************************
+
+.. image:: ../doc_images/logo-irap-couleur.png
+	:height: 100px
+	:align: center
+
++------------------------------+--------------------------------------------+
+| | IRAP                       | | Principal investigator: Etienne Pallier  | 
+| | 9 Avenue Colonel Roche     | | etienne.pallier@irap.omp.eu              |
+| | 31028 Toulouse Cedex 4     | | +33 5 61 55 66 48                        |
+| | FRANCE                     | | http://pyros.omp.eu/                     |
++------------------------------+--------------------------------------------+
+
+1. PyROS files
+**************
+
+Describe how the code is managed into folders.
+
+.. comments
+    .. toctree:: 
+       :maxdepth: 3
+        
+       using_mount_classes
+
+2. PyROS configuration files
+****************************
+
+Describe how the code is managed into folders.
+
+.. toctree:: 
+   :maxdepth: 3
+    
+   pyros_configuration
+
+3. Class and method documentation
+*********************************
+
+For developers of Python code in PyROS classes.
+
+.. toctree:: 
+   :maxdepth: 3
+
+   generate_documentation
+	
+The classes of PyROS.
+	 
+.. comments
+    .. toctree:: 
+       :maxdepth: 3
+
+       autodoc_pyros
+	
+
@@ -0,0 +1,5 @@
+c:\Users\alain\Anaconda3\Scripts\sphinx-build -b html . ..\doc_html
+c:\Users\alain\Anaconda3\Scripts\sphinx-build -b pdf . ..\doc_pdf
+
+
+
@@ -0,0 +1,13 @@
+********************************************
+PyROS configuration
+********************************************
+
+General principles
+******************
+
+Blabla.
+
+YAML files
+**********
+
+Blabla.