fix docs
This commit is contained in:
parent
c0fa9a0673
commit
4e356b12a4
BIN
docs/build/.DS_Store
vendored
BIN
docs/build/.DS_Store
vendored
Binary file not shown.
BIN
docs/build/doctrees/address.doctree
vendored
BIN
docs/build/doctrees/address.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/block.doctree
vendored
BIN
docs/build/doctrees/block.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/classes.doctree
vendored
BIN
docs/build/doctrees/classes.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/contributing.doctree
vendored
BIN
docs/build/doctrees/contributing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/examples.doctree
vendored
BIN
docs/build/doctrees/examples.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/functional.doctree
vendored
BIN
docs/build/doctrees/functional.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/installation.doctree
vendored
BIN
docs/build/doctrees/installation.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/transaction.doctree
vendored
BIN
docs/build/doctrees/transaction.doctree
vendored
Binary file not shown.
2
docs/build/html/_modules/index.html
vendored
2
docs/build/html/_modules/index.html
vendored
@ -105,7 +105,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
2
docs/build/html/_modules/pybtc/address.html
vendored
2
docs/build/html/_modules/pybtc/address.html
vendored
@ -322,7 +322,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
2
docs/build/html/_modules/pybtc/block.html
vendored
2
docs/build/html/_modules/pybtc/block.html
vendored
@ -131,7 +131,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
2
docs/build/html/_modules/pybtc/tools.html
vendored
2
docs/build/html/_modules/pybtc/tools.html
vendored
@ -1408,7 +1408,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -752,7 +752,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
BIN
docs/build/html/_static/pybtc.png
vendored
Normal file
BIN
docs/build/html/_static/pybtc.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 47 KiB |
2
docs/build/html/address.html
vendored
2
docs/build/html/address.html
vendored
@ -333,7 +333,7 @@ already contain in initial key parameter and will be ignored.</p>
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/address.rst.txt"
|
||||
|
||||
2
docs/build/html/block.html
vendored
2
docs/build/html/block.html
vendored
@ -120,7 +120,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/block.rst.txt"
|
||||
|
||||
2
docs/build/html/classes.html
vendored
2
docs/build/html/classes.html
vendored
@ -119,7 +119,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/classes.rst.txt"
|
||||
|
||||
2
docs/build/html/contributing.html
vendored
2
docs/build/html/contributing.html
vendored
@ -130,7 +130,7 @@ All tests located in <code class="docutils literal notranslate"><span class="pre
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/contributing.rst.txt"
|
||||
|
||||
2
docs/build/html/examples.html
vendored
2
docs/build/html/examples.html
vendored
@ -206,7 +206,7 @@ True
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/examples.rst.txt"
|
||||
|
||||
2
docs/build/html/functional.html
vendored
2
docs/build/html/functional.html
vendored
@ -961,7 +961,7 @@ address format use None.</li>
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/functional.rst.txt"
|
||||
|
||||
2
docs/build/html/genindex.html
vendored
2
docs/build/html/genindex.html
vendored
@ -378,7 +378,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
2
docs/build/html/index.html
vendored
2
docs/build/html/index.html
vendored
@ -208,7 +208,7 @@ or have some suggestion in order to improve the library.</p>
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/index.rst.txt"
|
||||
|
||||
2
docs/build/html/installation.html
vendored
2
docs/build/html/installation.html
vendored
@ -132,7 +132,7 @@ $ python3 setup.py install
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/installation.rst.txt"
|
||||
|
||||
2
docs/build/html/search.html
vendored
2
docs/build/html/search.html
vendored
@ -118,7 +118,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
2
docs/build/html/transaction.html
vendored
2
docs/build/html/transaction.html
vendored
@ -120,7 +120,7 @@
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
|
||||
|
||||
|
|
||||
<a href="_sources/transaction.rst.txt"
|
||||
|
||||
216
docs/source/conf.py.old
Normal file
216
docs/source/conf.py.old
Normal file
@ -0,0 +1,216 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file does only contain 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
|
||||
from sphinx.ext.autodoc import (
|
||||
ClassLevelDocumenter, InstanceAttributeDocumenter)
|
||||
|
||||
|
||||
sys.path.insert(0, os.path.abspath('.'))
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
sys.path.insert(0, os.path.abspath('../_static/'))
|
||||
sys.path.insert(0, os.path.abspath('../../_static/'))
|
||||
sys.path.insert(0, os.path.abspath('../../pybtc/'))
|
||||
sys.path.insert(0, os.path.abspath('../../pybtc'))
|
||||
sys.path.insert(0, os.path.abspath('./_static/'))
|
||||
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'pybtc'
|
||||
copyright = '2015-2018, bitaps.com'
|
||||
author = 'Aleksey Karpov'
|
||||
|
||||
|
||||
def iad_add_directive_header(self, sig):
|
||||
ClassLevelDocumenter.add_directive_header(self, sig)
|
||||
|
||||
InstanceAttributeDocumenter.add_directive_header = iad_add_directive_header
|
||||
|
||||
# The short X.Y version
|
||||
version = ''
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = ''
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# 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.doctest',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.coverage',
|
||||
'sphinx.ext.mathjax',
|
||||
'sphinx.ext.ifconfig',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.githubpages',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# 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 = 'sphinx'
|
||||
|
||||
|
||||
# -- 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'
|
||||
|
||||
html_theme_options = {
|
||||
'logo': 'pybtc.png',
|
||||
'description': ' ',
|
||||
'github_banner': True,
|
||||
'github_button': True,
|
||||
'github_user': 'bitaps-com',
|
||||
'github_repo': 'pybtc',
|
||||
'page_width': '1100px',
|
||||
'caption_font_family': "sans-serif",
|
||||
'font_family': "sans-serif",
|
||||
'font_size': '16px'
|
||||
}
|
||||
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'about.html',
|
||||
'navigation.html',
|
||||
'relations.html',
|
||||
'searchbox.html',
|
||||
'donate.html',
|
||||
]
|
||||
}
|
||||
# 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 = {}
|
||||
|
||||
# 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']
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
#
|
||||
# The default sidebars (for documents that don't match any pattern) are
|
||||
# defined by theme itself. Builtin themes are using these templates by
|
||||
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
||||
# 'searchbox.html']``.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'pybtcdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'pybtc.tex', 'pybtc Documentation',
|
||||
'Aleksey Karpov', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'pybtc', 'pybtc Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Texinfo output ----------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'pybtc', 'pybtc Documentation',
|
||||
author, 'pybtc', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
||||
|
||||
# -- Options for intersphinx extension ---------------------------------------
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {'https://docs.python.org/': None}
|
||||
|
||||
# -- Options for todo extension ----------------------------------------------
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
Loading…
Reference in New Issue
Block a user