Skip to content
Snippets Groups Projects
Commit 9455a231 authored by roadscape's avatar roadscape
Browse files

remove sphinx

parent d24068a9
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Pipfile
+ 0
− 4
View file @ 9455a231
......@@ -25,9 +25,5 @@ pytest = "*"
"pytest-console-scripts" = "*"
"pytest-docker" = "*"
"pytest-pylint" = "*"
recommonmark = "*"
"sphinxcontrib-programoutput" = "*"
"sphinxcontrib-restbuilder" = "*"
yapf = "*"
sphinx = "*"
"autopep8" = "*"
docs/Makefile deleted 100644 → 0
+ 0
− 21
View file @ d24068a9
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = steem-python
SOURCEDIR = .
BUILDDIR = _build
_README = ../README.rst
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
docs/conf.py deleted 100644 → 0
+ 0
− 162
View file @ d24068a9
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# hive documentation build configuration file, created by
# sphinx-quickstart on Mon Mar 6 14:00:07 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# 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('.'))
# -- 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.
import sphinx_rtd_theme
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx.ext.napoleon',
# 'sphinxcontrib.programoutput',
# 'sphinxcontrib.restbuilder',
]
# 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'
# General information about the project.
project = 'hive'
copyright = '2017, Steemit Inc'
author = 'furion@steemit.com'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1.0'
# The full version, including alpha/beta/rc tags.
release = '0.1.0'
# 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 patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- 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 = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# 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']
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'hivedoc'
# -- 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, 'hive.tex', 'hive Documentation',
'furion@steemit.com', '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, 'hive', 'hive 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, 'hive', 'hive Documentation',
author, 'hive', 'One line description of project.',
'Miscellaneous'),
]
docs/dev-requirements.txt deleted 100644 → 0
+ 0
− 12
View file @ d24068a9
pytest
pytest-runner
pytest-pylint
pep8
yapf
sphinx
recommonmark
sphinxcontrib-restbuilder
sphinxcontrib-programoutput
pytest-console-scripts
sphinxcontrib-napoleon
sphinx_rtd_theme
docs/index.rst deleted 100644 → 0
+ 0
− 30
View file @ d24068a9
Welcome to hive
===============
``hive`` is a community consensus layer for the Steem blockchain.
Installation
------------
To install the library, simply run:
::
pip install -U hive
Getting Started
---------------
.. toctree::
:maxdepth: 1
install
cli
modules
Other
-----
* :ref:`genindex`
docs/install.rst deleted 100644 → 0
+ 0
− 31
View file @ d24068a9
************
Installation
************
`hive` requires Python 3.5 or higher. We don't recommend usage of Python that ships with OS.
If you're just looking for a quick and easy cross-platform solution, feel free to install Python 3.x via easy to use
`Anaconda <https://www.continuum.io/downloads>`_ installer.
Afterwards, you can install `hive` with `pip`:
::
$ pip install hive
You can also perform the installation manually using `setup.py`:
::
$ git clone https://github.com/steemit/hivemind
$ cd hive
$ make install
Upgrade
#######
::
$ pip install -U hive
docs/modules.rst deleted 100644 → 0
+ 0
− 79
View file @ d24068a9
Modules
~~~~~~~
**hive** is comprised of the following modules:
- ``hive.indexer``
- ``hive.db``
- ``hive.server``
- ``hive.extras``
Indexer
=======
hive.indexer.core
-----------------
.. automodule:: hive.indexer.core
:members:
--------
Server
======
.. automodule:: hive.server
:members:
Health Check
------------
To perform a health check, perform a `GET` on ``/health``.
Returns 200 if everything is OK, and 500 /w json error message otherwise.
JSON-RPC Example
----------------
.. code-block:: python
from jsonrpcclient.http_client import HTTPClient
HTTPClient('http://localhost:1234').request('hive.status')
Outputs:
::
--> {"jsonrpc": "2.0", "method": "hive.status", "id": 8}
<-- {"result": {"diff": 6396850, "hive": 5042966, "steemd": 11439816}, "id": 8, "jsonrpc": "2.0"} (200 OK)
Result: {'diff': 6396850, 'hive': 5042966, 'steemd': 11439816}
--------
Community
=========
Community
---------
.. autoclass:: hive.community.community.Community
:members:
Roles
-----
.. automodule:: hive.community.roles
:members:
--------
Database
========
hive.db.methods
---------------
.. automodule:: hive.db.methods
:members:
--------
\ No newline at end of file
setup.cfg
+ 0
− 5
View file @ 9455a231
[aliases]
test=pytest
[build_sphinx]
source-dir = docs/
build-dir = docs/_build
all_files = 1
[pycodestyle]
# formerly pep8
......
setup.py
+ 0
− 4
View file @ 9455a231
......@@ -18,10 +18,6 @@ setup(
'pep8',
'pytest-pylint',
'yapf',
'sphinx',
'recommonmark',
'sphinxcontrib-restbuilder',
'sphinxcontrib-programoutput',
'pytest-console-scripts'],
install_requires=[
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment