Set up for Documentation

[LuisOlivaresJ]

1. New docs folder to found Documentation structure

   • docs/source/index.rst is the root document (root of the “table of contents tree” or toctree)
   • README.rst continues to be the welcome page, but using a new format (reStructuredText)
   • docs/source/installation.rst for installation instructions
   • The main module overview is imported from the corresponding Docstring (E. g. from src/omg_dosimetry/calibration.py docstring)

2. To do: import our documentation 2.1 Create an account on Read The Docs 2.2 Sign up or log in at Read the Docs with your GitHub account 2.3 Import our documentation repository (here is a guide). Just for meantime, I suguest to use the "Documentation" branch instead the base "OMG_master" 2.4 On Administration, include me as a Maintainer

[jfcabana]

I followed the steps to setup the project on Read the Docs. The compilation failed. Seems to be related to the requirements.txtfile?

[LuisOlivaresJ]

Fixed. It seems that Read The Docs was trying to automatically use "requirements.txt" instead "requierements_read_the_docs.txt". I just renamed the first one and it worked. I am considering to delete it.

Have you see the output page? It is beautiful :blush:

[jfcabana]

Yep, looking good!

I thought the docstrings from the three modules would appear in the docs, but that does not seem to be the case?

[LuisOlivaresJ]

Do you mean the docs folder? For example, the content in calibration.rst file, is going to be the information to be show for the Calibration module on the web page. This is how it works, with the addition of two lines of code (see #7),

All the docstring from LUT's class (from PyPi omg_dosimetry package) is going to be show on the web page.

[jfcabana]

Yes, that is it! There are several classes and functions that I think would be a good idea to include in the documentation.

[LuisOlivaresJ]

Perfect. I'll work on installation.rst to take acount about the spyder requeriment.