initial commit

This commit is contained in:
2019-05-19 14:31:05 +02:00
commit 019c8cb13a
60 changed files with 16194 additions and 0 deletions

View File

@@ -0,0 +1,7 @@
/*
* basic.css
* https://github.com/sphinx-doc/sphinx/blob/master/sphinx/themes/basic/static/basic.css_t
*/
table.indextable tr.cap {
background-color: #333;
}

79
docs/source/conf.py Normal file
View File

@@ -0,0 +1,79 @@
# 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:
# http://www.sphinx-doc.org/en/master/config
# -- 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
sys.path.insert(0, os.path.abspath('../../src'))
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# -- Project information -----------------------------------------------------
project = 'pylib'
copyright = '2019, Daniel Weschke'
author = 'Daniel Weschke'
# The full version, including alpha/beta/rc tags
release = '2019.5.19'
# -- 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'
]
# 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 = []
# -- 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'
# 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']
html_context = {
'css_files': ['_static/custom.css'],
}
html_theme_options = {
'base_bg': '#292b2e',
'base_text': '#b2b2b2',
'body_text': '#b2b2b2',
'code_text': '#b2b2b2',
'code_hover': 'transparent',
'sidebar_text': '#b2b2b2',
'sidebar_link': '#b2b2b2',
'sidebar_header': '#b2b2b2',
'link': '#5799b9',
'link_hover': '#ce537a',
'highlight_bg': '#444F65',
'xref_bg': 'transparent',
'xref_border': 'transparent',
}

7
docs/source/data.rst Normal file
View File

@@ -0,0 +1,7 @@
data module
===========
.. automodule:: data
:members:
:undoc-members:
:show-inheritance:

7
docs/source/date.rst Normal file
View File

@@ -0,0 +1,7 @@
date module
===========
.. automodule:: date
:members:
:undoc-members:
:show-inheritance:

7
docs/source/fit.rst Normal file
View File

@@ -0,0 +1,7 @@
fit module
==========
.. automodule:: fit
:members:
:undoc-members:
:show-inheritance:

7
docs/source/geometry.rst Normal file
View File

@@ -0,0 +1,7 @@
geometry module
===============
.. automodule:: geometry
:members:
:undoc-members:
:show-inheritance:

20
docs/source/index.rst Normal file
View File

@@ -0,0 +1,20 @@
.. pylib documentation master file, created by
sphinx-quickstart on Sun May 19 11:04:24 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pylib's documentation!
=================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

10
docs/source/modules.rst Normal file
View File

@@ -0,0 +1,10 @@
src
===
.. toctree::
:maxdepth: 4
data
date
fit
geometry

46
docs/source/src.rst Normal file
View File

@@ -0,0 +1,46 @@
src package
===========
Submodules
----------
src.data module
---------------
.. automodule:: src.data
:members:
:undoc-members:
:show-inheritance:
src.date module
---------------
.. automodule:: src.date
:members:
:undoc-members:
:show-inheritance:
src.fit module
--------------
.. automodule:: src.fit
:members:
:undoc-members:
:show-inheritance:
src.geometry module
-------------------
.. automodule:: src.geometry
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: src
:members:
:undoc-members:
:show-inheritance: