Skip to content

Commit 1647316

Browse files
thusserthusser
authored
v0.16.0
version 0.16.0
2 parents 1077435 + 29a73b9 commit 1647316

File tree

11 files changed

+2974
-52
lines changed

11 files changed

+2974
-52
lines changed

‎.pre-commit-config.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
repos:
2+
- repo: https://github.com/psf/black
3+
rev: 21.12b0
4+
hooks:
5+
- id: black
6+
language_version: python3.9

‎.readthedocs.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-20.04
5+
tools:
6+
python: "3.9"
7+
8+
sphinx:
9+
configuration: docs/source/conf.py
10+
11+
python:
12+
install:
13+
- method: pip
14+
path: .

‎docs/Makefile

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = pyobs
8+
SOURCEDIR = source
9+
BUILDDIR = ../.doc-build
10+
11+
#.EXPORT_ALL_VARIABLES:
12+
13+
#PYTHONPATH:=../pyobs-core/:../pyobs-sbig/:../pyobs-fli:../pyobs-weather:../pyobs-archive:${PYTHONPATH}
14+
15+
# Put it first so that "make" without argument is like "make help".
16+
help:
17+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
18+
19+
.PHONY: help Makefile
20+
21+
html:
22+
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
23+
24+
livehtml:
25+
sphinx-autobuild -b html --watch ../pyobs_sbig $(ALLSPHINXOPTS) "$(SOURCEDIR)/" "$(BUILDDIR)/html/"
26+
27+
# Catch-all target: route all unknown targets to Sphinx using the new
28+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
29+
%: Makefile
30+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
31+

‎docs/make.bat

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
set SPHINXPROJ=pyobs
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20+
echo.installed, then set the SPHINXBUILD environment variable to point
21+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22+
echo.may add the Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.http://sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30+
goto end
31+
32+
:help
33+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34+
35+
:end
36+
popd

‎docs/source/_static/pyobs.gif

1.75 KB
Loading

‎docs/source/conf.py

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Configuration file for the Sphinx documentation builder.
4+
#
5+
# This file does only contain a selection of the most common options. For a
6+
# full list see the documentation:
7+
# http://www.sphinx-doc.org/en/stable/config
8+
9+
# -- Path setup --------------------------------------------------------------
10+
11+
# If extensions (or modules to document with autodoc) are in another directory,
12+
# add these directories to sys.path here. If the directory is relative to the
13+
# documentation root, use os.path.abspath to make it absolute, like shown here.
14+
#
15+
import os
16+
import sys
17+
18+
sys.path.insert(0, os.path.abspath("../../"))
19+
20+
21+
# -- Project information -----------------------------------------------------
22+
23+
project = "pyobs-fli"
24+
copyright = "2022, Tim-Oliver Husser"
25+
author = "Tim-Oliver Husser"
26+
27+
# The short X.Y version
28+
# version = "0.16"
29+
# The full version, including alpha/beta/rc tags
30+
# release = "0.16.0"
31+
32+
33+
# -- General configuration ---------------------------------------------------
34+
35+
add_module_names = False
36+
37+
# If your documentation needs a minimal Sphinx version, state it here.
38+
#
39+
# needs_sphinx = '1.0'
40+
41+
# Add any Sphinx extension module names here, as strings. They can be
42+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
43+
# ones.
44+
extensions = [
45+
"sphinx.ext.autodoc",
46+
"sphinx.ext.githubpages",
47+
"sphinx.ext.napoleon",
48+
"sphinx.ext.viewcode",
49+
"sphinx.ext.autosectionlabel",
50+
"sphinx.ext.intersphinx",
51+
#'sphinx_autodoc_typehints'
52+
]
53+
54+
intersphinx_mapping = {"http://docs.python.org/3": None}
55+
56+
# napoleon settings
57+
napoleon_google_docstring = True
58+
napoleon_numpy_docstring = False
59+
napoleon_use_param = False
60+
napoleon_use_ivar = True
61+
62+
# typehints
63+
# set_type_checking_flag = True
64+
# autodoc_typehints = "description"
65+
66+
# show c'tor parameters in class only
67+
autoclass_content = "both"
68+
69+
# Add any paths that contain templates here, relative to this directory.
70+
templates_path = ["_templates"]
71+
72+
# The suffix(es) of source filenames.
73+
# You can specify multiple suffix as a list of string:
74+
#
75+
source_suffix = ".rst"
76+
77+
# The master toctree document.
78+
master_doc = "index"
79+
80+
# The language for content autogenerated by Sphinx. Refer to documentation
81+
# for a list of supported languages.
82+
#
83+
# This is also used if you do content translation via gettext catalogs.
84+
# Usually you set "language" from the command line for these cases.
85+
language = "en"
86+
87+
# List of patterns, relative to source directory, that match files and
88+
# directories to ignore when looking for source files.
89+
# This pattern also affects html_static_path and html_extra_path .
90+
exclude_patterns = []
91+
92+
# The name of the Pygments (syntax highlighting) style to use.
93+
pygments_style = "sphinx"
94+
95+
# Be a little nitpicky
96+
nitpicky = True
97+
nitpick_ignore = []
98+
99+
# intersphinx
100+
intersphinx_mapping = {
101+
"pyobs": ("https://pyobs-core.readthedocs.io/en/latest/", None),
102+
}
103+
104+
# -- Options for HTML output -------------------------------------------------
105+
106+
# The theme to use for HTML and HTML Help pages. See the documentation for
107+
# a list of builtin themes.
108+
html_theme = "sphinx_rtd_theme"
109+
html_theme_options = {
110+
"collapse_navigation": False,
111+
"sticky_navigation": True,
112+
"navigation_depth": 4,
113+
"display_version": False,
114+
"logo_only": False,
115+
"prev_next_buttons_location": "bottom",
116+
"titles_only": False,
117+
"style_nav_header_background": "#cccccc",
118+
}
119+
html_logo = "_static/pyobs.gif"

‎docs/source/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
pyobs-fli
2+
#########
3+
4+
This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for FLI cameras.
5+
6+
7+
Example configuration
8+
*********************
9+
10+
11+
Available classes
12+
*****************
13+
14+
There is one single class for FLI cameras.
15+
16+
AsiCamera
17+
=========
18+
.. autoclass:: pyobs_fli.FliCamera
19+
:members:
20+
:show-inheritance:

0 commit comments

Comments
 (0)