About¶
This document¶
This document is created uisng Sphinx and autodoc. The general rule of the static html is configured in reStructuredText and api document is generated by Sphinx-apidoc, configure in conf.py.
The general html structure looks like below:
html/
├── about.html
├── conf.html
├── genindex.html
├── index.html
├── install.html
├── _modules
│ ├── index.html
│ └── scibeam
│ ├── core
│ │ ├── base.html
│ │ ├── common.html
│ │ ├── descriptor.html
│ │ ├── formatter.html
│ │ ├── gaussian.html
│ │ ├── numerical.html
│ │ ├── peak.html
│ │ ├── plot.html
│ │ ├── regexp.html
│ │ ├── tofframe.html
│ │ └── tofseries.html
│ └── tests
│ ├── test_base.html
│ ├── test_common.html
│ ├── test_formatter.html
│ ├── test_imports.html
│ ├── test_regexp.html
│ └── test_tofseries.html
├── modules.html
├── objects.inv
├── py-modindex.html
├── scibeam.core.html
├── scibeam.html
├── scibeam.tests.html
├── search.html
├── searchindex.js
├── setup.html
├── _sources
│ ├── about.rst.txt
│ ├── conf.rst.txt
│ ├── index.rst.txt
│ ├── install.rst.txt
│ ├── modules.rst.txt
│ ├── scibeam.core.rst.txt
│ ├── scibeam.rst.txt
│ ├── scibeam.tests.rst.txt
│ ├── setup.rst.txt
│ ├── structure.rst.txt
│ └── tutorial.rst.txt
├── _static
│ ├── ajax-loader.gif
│ ├── alabaster.css
│ ├── basic.css
│ ├── comment-bright.png
│ ├── comment-close.png
│ ├── comment.png
│ ├── css
│ │ ├── badge_only.css
│ │ └── theme.css
│ ├── custom.css
│ ├── doctools.js
│ ├── documentation_options.js
│ ├── down.png
│ ├── down-pressed.png
│ ├── file.png
│ ├── fonts
│ │ ├── fontawesome-webfont.eot
│ │ ├── fontawesome-webfont.svg
│ │ ├── fontawesome-webfont.ttf
│ │ ├── fontawesome-webfont.woff
│ │ ├── fontawesome-webfont.woff2
│ │ ├── Lato
│ │ │ ├── lato-bold.eot
│ │ │ ├── lato-bolditalic.eot
│ │ │ ├── lato-bolditalic.ttf
│ │ │ ├── lato-bolditalic.woff
│ │ │ ├── lato-bolditalic.woff2
│ │ │ ├── lato-bold.ttf
│ │ │ ├── lato-bold.woff
│ │ │ ├── lato-bold.woff2
│ │ │ ├── lato-italic.eot
│ │ │ ├── lato-italic.ttf
│ │ │ ├── lato-italic.woff
│ │ │ ├── lato-italic.woff2
│ │ │ ├── lato-regular.eot
│ │ │ ├── lato-regular.ttf
│ │ │ ├── lato-regular.woff
│ │ │ └── lato-regular.woff2
│ │ └── RobotoSlab
│ │ ├── roboto-slab-v7-bold.eot
│ │ ├── roboto-slab-v7-bold.ttf
│ │ ├── roboto-slab-v7-bold.woff
│ │ ├── roboto-slab-v7-bold.woff2
│ │ ├── roboto-slab-v7-regular.eot
│ │ ├── roboto-slab-v7-regular.ttf
│ │ ├── roboto-slab-v7-regular.woff
│ │ └── roboto-slab-v7-regular.woff2
│ ├── jquery-3.2.1.js
│ ├── jquery.js
│ ├── js
│ │ ├── modernizr.min.js
│ │ └── theme.js
│ ├── minus.png
│ ├── plus.png
│ ├── pygments.css
│ ├── searchtools.js
│ ├── underscore-1.3.1.js
│ ├── underscore.js
│ ├── up.png
│ ├── up-pressed.png
│ └── websupport.js
├── structure.html
└── tutorial.html
11 directories, 101 files
reStructuredText Sturcture¶
The reStructuredText files are the source that these htmls are build on top of. Most of the text related .rst fils are wrote in the corresponding mark up formart, other module related .rst are build using autodoc, which automatically looks in to the doc strings in python source files.
In this project, the document style in the pyhon source files are following numpy style, which is rendered by Spnhinx externsion napoleon.
The structure of .rst folder structure:
├── about.rst
├── conf.py
├── index.rst
├── install.rst
├── modules.rst
├── scibeam.core.rst
├── scibeam.rst
├── scibeam.tests.rst
├── _static
├── structure.rst
└── _templates
2 directories, 11 files
Package structure¶
The package structure of scibeam is
scibeam
├── core
│ ├── base.py
│ ├── common.py
│ ├── descriptor.py
│ ├── dictfunc.py
│ ├── formatter.py
│ ├── gaussian.py
│ ├── __init__.py
│ ├── numerical.py
│ ├── peak.py
│ ├── plot.py
│ ├── regexp.py
│ ├── tofframe.py
│ └── tofseries.py
├── data
│ ├── examples
│ └── test
├── __init__.py
├── tests
│ ├── __init__.py
│ ├── __pycache__
│ ├── test_base.py
│ ├── test_common.py
│ ├── test_formatter.py
│ ├── test_imports.py
│ ├── test_regexp.py
│ └── test_tofseries.py
└── util
├── folderstruct.py
├── __init__.py
├── io.py
├── multiframe.py
└── pipeline.py
10 directories, 34 files
Where:
- core: main part of the pacaage
- tests: unittests
- util: extral add ons for the package
- data: test data and example data files