Skip to content

Commit ecee14e

Browse files
artemlosartemlos
committed
Add python docs
1 parent b946527 commit ecee14e

File tree

6 files changed

+266
-2
lines changed

6 files changed

+266
-2
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ __pycache__/
33
*.py[cod]
44
*$py.class
55

6+
_build
7+
68
# C extensions
79
*.so
810

‎Makefile‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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+
SOURCEDIR = .
8+
BUILDDIR = _build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎conf.py‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
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/master/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+
from licensing import *
20+
21+
# -- Project information -----------------------------------------------------
22+
23+
project = 'cryptolens python'
24+
copyright = '2019, Cryptolens AB'
25+
author = 'Cryptolens AB'
26+
27+
# The short X.Y version
28+
version = ''
29+
# The full version, including alpha/beta/rc tags
30+
release = '0.5'
31+
32+
33+
# -- General configuration ---------------------------------------------------
34+
35+
# If your documentation needs a minimal Sphinx version, state it here.
36+
#
37+
# needs_sphinx = '1.0'
38+
39+
# Add any Sphinx extension module names here, as strings. They can be
40+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41+
# ones.
42+
extensions = [
43+
'sphinx.ext.viewcode',
44+
'sphinx.ext.autodoc'
45+
]
46+
47+
# Add any paths that contain templates here, relative to this directory.
48+
templates_path = ['_templates']
49+
50+
# The suffix(es) of source filenames.
51+
# You can specify multiple suffix as a list of string:
52+
#
53+
# source_suffix = ['.rst', '.md']
54+
source_suffix = '.rst'
55+
56+
# The master toctree document.
57+
master_doc = 'index'
58+
59+
# The language for content autogenerated by Sphinx. Refer to documentation
60+
# for a list of supported languages.
61+
#
62+
# This is also used if you do content translation via gettext catalogs.
63+
# Usually you set "language" from the command line for these cases.
64+
language = None
65+
66+
# List of patterns, relative to source directory, that match files and
67+
# directories to ignore when looking for source files.
68+
# This pattern also affects html_static_path and html_extra_path.
69+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
70+
71+
# The name of the Pygments (syntax highlighting) style to use.
72+
pygments_style = None
73+
74+
75+
# -- Options for HTML output -------------------------------------------------
76+
77+
# The theme to use for HTML and HTML Help pages. See the documentation for
78+
# a list of builtin themes.
79+
#
80+
html_theme = 'alabaster'
81+
82+
# Theme options are theme-specific and customize the look and feel of a theme
83+
# further. For a list of options available for each theme, see the
84+
# documentation.
85+
#
86+
# html_theme_options = {}
87+
88+
# Add any paths that contain custom static files (such as style sheets) here,
89+
# relative to this directory. They are copied after the builtin static files,
90+
# so a file named "default.css" will overwrite the builtin "default.css".
91+
html_static_path = ['_static']
92+
93+
# Custom sidebar templates, must be a dictionary that maps document names
94+
# to template names.
95+
#
96+
# The default sidebars (for documents that don't match any pattern) are
97+
# defined by theme itself. Builtin themes are using these templates by
98+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
99+
# 'searchbox.html']``.
100+
#
101+
# html_sidebars = {}
102+
103+
104+
# -- Options for HTMLHelp output ---------------------------------------------
105+
106+
# Output file base name for HTML help builder.
107+
htmlhelp_basename = 'cryptolenspythondoc'
108+
109+
110+
# -- Options for LaTeX output ------------------------------------------------
111+
112+
latex_elements = {
113+
# The paper size ('letterpaper' or 'a4paper').
114+
#
115+
# 'papersize': 'letterpaper',
116+
117+
# The font size ('10pt', '11pt' or '12pt').
118+
#
119+
# 'pointsize': '10pt',
120+
121+
# Additional stuff for the LaTeX preamble.
122+
#
123+
# 'preamble': '',
124+
125+
# Latex figure (float) alignment
126+
#
127+
# 'figure_align': 'htbp',
128+
}
129+
130+
# Grouping the document tree into LaTeX files. List of tuples
131+
# (source start file, target name, title,
132+
# author, documentclass [howto, manual, or own class]).
133+
latex_documents = [
134+
(master_doc, 'cryptolenspython.tex', 'cryptolens python Documentation',
135+
'Cryptolens AB', 'manual'),
136+
]
137+
138+
139+
# -- Options for manual page output ------------------------------------------
140+
141+
# One entry per manual page. List of tuples
142+
# (source start file, name, description, authors, manual section).
143+
man_pages = [
144+
(master_doc, 'cryptolenspython', 'cryptolens python Documentation',
145+
[author], 1)
146+
]
147+
148+
149+
# -- Options for Texinfo output ----------------------------------------------
150+
151+
# Grouping the document tree into Texinfo files. List of tuples
152+
# (source start file, target name, title, author,
153+
# dir menu entry, description, category)
154+
texinfo_documents = [
155+
(master_doc, 'cryptolenspython', 'cryptolens python Documentation',
156+
author, 'cryptolenspython', 'One line description of project.',
157+
'Miscellaneous'),
158+
]
159+
160+
161+
# -- Options for Epub output -------------------------------------------------
162+
163+
# Bibliographic Dublin Core info.
164+
epub_title = project
165+
166+
# The unique identifier of the text. This can be a ISBN number
167+
# or the project homepage.
168+
#
169+
# epub_identifier = ''
170+
171+
# A unique identification for the text.
172+
#
173+
# epub_uid = ''
174+
175+
# A list of files that should not be packed into the epub file.
176+
epub_exclude_files = ['search.html']
177+
178+
179+
# -- Extension configuration -------------------------------------------------

‎index.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. cryptolens python documentation master file, created by
2+
sphinx-quickstart on Fri Feb 1 14:18:52 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to cryptolens python's documentation!
7+
=============================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
.. automodule:: licensing
13+
:members:
14+
.. autoclass:: licensing.methods.Key
15+
:members:
16+
.. autoclass:: licensing.models.LicenseKey
17+
:members:
18+
.. autoclass:: licensing.methods.Helpers
19+
:members:
20+
.. autoclass:: licensing.models.ActivatedMachine
21+
:members:
22+
.. autoclass:: licensing.models.Response
23+
:members:
24+
25+
Indices and tables
26+
==================
27+
28+
* :ref:`genindex`
29+
* :ref:`modindex`
30+
* :ref:`search`

‎make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33+
34+
:end
35+
popd

‎test.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,4 @@
4040
print("Feature 1: " + str(license_key.f1))
4141
print("License expires: " + str(license_key.expires))
4242

43-
print(Helpers.GetMachineCode())
44-
43+
print(Helpers.GetMachineCode())

0 commit comments

Comments
 (0)