Here we have done the set-up to write doc string documentation using Sphinx. Sphinx is a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. That is, Sphinx can generate a series of HTML files, or a PDF file (via LaTeX). This will be our tool to generate the PyWiFeS User Manual. See more info about Sphinx and how to do the set-up here.
These are the main changes of this PR:
To enable Sphinx, there is a new directory pipeline/docs.
We have written the doc strings in the module pipeline/src/pywifes/data_classifier.py to use as a guide from now on.
We have removed all the unused files, modules and directories in the repository. We have amended pipeline/src/pywifes/__init__.py accordingly.
Here we have done the set-up to write doc string documentation using
Sphinx.Sphinxis a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. That is,Sphinxcan generate a series of HTML files, or a PDF file (via LaTeX). This will be our tool to generate the PyWiFeS User Manual. See more info aboutSphinxand how to do the set-up here.These are the main changes of this PR:
Sphinx, there is a new directorypipeline/docs.pipeline/src/pywifes/data_classifier.pyto use as a guide from now on.pipeline/src/pywifes/__init__.pyaccordingly.