-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from sdevenes/feature/code_documentation
Feature/code documentation
Showing
14 changed files
with
343 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,9 @@ | ||
### Data source files ### | ||
data/ | ||
|
||
### Sphinx Doc ### | ||
docs/build/* | ||
public/* | ||
|
||
### Python execution ### | ||
scripts/__pycache__/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line, and also | ||
# from the environment for the first two. | ||
SPHINXOPTS ?= | ||
SPHINXBUILD ?= sphinx-build | ||
SOURCEDIR = source | ||
BUILDDIR = build | ||
LIBDIR = ../scripts | ||
OUTPUTDIR = ../public | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
#%: Makefile | ||
# @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: clean | ||
clean: | ||
rm -rf $(BUILDDIR)/* | ||
|
||
.PHONY: gendocs | ||
gendocs: | ||
sphinx-apidoc -f -o "$(SOURCEDIR)" "$(LIBDIR)" --separate | ||
|
||
.PHONY: html | ||
html: gendocs | ||
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
@echo | ||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | ||
mkdir -p $(OUTPUTDIR)/html/ | ||
cp -R $(BUILDDIR)/html/* $(OUTPUTDIR) | ||
@echo "html files copied; the html files are in $(OUTPUTDIR)." | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
algorithm module | ||
================ | ||
|
||
.. automodule:: algorithm | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
analysis module | ||
=============== | ||
|
||
.. automodule:: analysis | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
# Configuration file for the Sphinx documentation builder. | ||
# | ||
# This file only contains a selection of the most common options. For a full | ||
# list see the documentation: | ||
# https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
||
# -- Path setup -------------------------------------------------------------- | ||
|
||
# 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 | ||
import subprocess | ||
sys.path.insert(0, os.path.abspath('../../scripts')) | ||
|
||
|
||
# -- Project information ----------------------------------------------------- | ||
AUTHOR='Spano Amara, Devènes Steve' | ||
VERSION = "0.1.0" # subprocess.check_output(["git", "describe"]).decode('UTF-8') | ||
|
||
project = 'M05 miniProject' | ||
copyright = '2020' | ||
author = 'Spano Amara, Devènes Steve' | ||
|
||
author = AUTHOR | ||
|
||
# The short X.Y version | ||
version = VERSION | ||
# The full version, including alpha/beta/rc tags | ||
release = VERSION | ||
|
||
# -- General configuration --------------------------------------------------- | ||
|
||
# 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.napoleon', | ||
] | ||
|
||
# Also document special classes like __init__ | ||
autoclass_content = 'both' | ||
|
||
# Add any paths that contain templates here, relative to this directory. | ||
templates_path = ['_templates'] | ||
|
||
# List of patterns, relative to source directory, that match files and | ||
# directories to ignore when looking for source files. | ||
# This pattern also affects html_static_path and html_extra_path. | ||
exclude_patterns = [] | ||
|
||
# The name of the Pygments (syntax highlighting) style to use. | ||
pygments_style = 'pastie' | ||
|
||
# -- 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 = {} | ||
# html_favicon = '../../img/***.png' | ||
|
||
# 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'] | ||
|
||
|
||
# -- Extension configuration ------------------------------------------------- | ||
#autodoc_mock_imports = ['pandas'] | ||
|
||
napoleon_google_docstring = True | ||
napoleon_numpy_docstring = False | ||
|
||
html_theme_options = { | ||
'logo_only': False, | ||
'display_version': True, | ||
'prev_next_buttons_location': 'bottom', | ||
'style_external_links': False, | ||
#'vcs_pageview_mode': 'blob', | ||
#'style_nav_header_background': '#da0066', | ||
# Toc options | ||
'collapse_navigation': False, | ||
'sticky_navigation': True, | ||
'navigation_depth': -1, | ||
'includehidden': True, | ||
'titles_only': False, | ||
} | ||
|
||
# html_context = { | ||
# "display_gitlab": True, | ||
# "gitlab_user": "", | ||
# "gitlab_repo": "", | ||
# "gitlab_version": "master", | ||
# "conf_py_path": "/docs/source/", | ||
# "gitlab_host": "", | ||
# } | ||
|
||
# html_logo = '../../img/****.svg' | ||
html_title = 'M05 MiniProject docs' | ||
|
||
# Option for linkcheck | ||
linkcheck_anchors=False |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
database module | ||
=============== | ||
|
||
.. automodule:: database | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
download\_data module | ||
===================== | ||
|
||
.. automodule:: download_data | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
Welcome to M05 miniProject's documentation! | ||
=========================================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:hidden: | ||
:caption: Contents | ||
:glob: | ||
|
||
modules | ||
|
||
Getting started | ||
--------------- | ||
|
||
You can view the content as a: | ||
|
||
* `Webpage <https://put/the/correct/link/here/>`_ | ||
* `pdf <https://is/there/a/pdf?.pdf>`_ | ||
|
||
|
||
Authors | ||
------- | ||
|
||
* `Amara Spano - Github Profile <https://github.com/spanoamara>`_ | ||
* `Steve Devenes - Github Profile <https://github.com/sdevenes>`_ | ||
|
||
License | ||
------- | ||
|
||
todo | ||
|
||
Indices and tables | ||
------------------ | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
scripts | ||
======= | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
algorithm | ||
analysis | ||
database | ||
download_data | ||
test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
test module | ||
=========== | ||
|
||
.. automodule:: test | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
requests | ||
sklearn | ||
plotly.express | ||
plotly.express | ||
sphinx | ||
sphinx_rtd_theme |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters