Skip to content

Commit

Permalink
conversion of docs to reStructuredText with some minor alterations. I…
Browse files Browse the repository at this point in the history
…ssue #41
  • Loading branch information
mikeshultz committed Mar 23, 2019
1 parent abd7f4e commit 2fee844
Show file tree
Hide file tree
Showing 28 changed files with 815 additions and 269 deletions.
19 changes: 19 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# 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)
64 changes: 49 additions & 15 deletions docs/commands.md → docs/commands.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,40 @@
# Commands
########
Commands
########

## `init`
************
:code:`init`
************

Create a project using a template or bare. For instance, creating an ERC20
project from the template:

sb init -t erc20

## `compile`
***************
:code:`compile`
***************

Compile the contracts.

sb compile

## `test`
************
:code:`test`
************

Test the contracts using pytest(?)

sb test

## `console`
***************
:code:`console`
***************

Start a pythonic console for testing contracts. Provides web3 and contracts as local variables.

.. code-block:: bash
$ sb console dev
2018-10-28 17:42:38,022 [INFO] solidbyte.cli.console - Starting interactive console...
Solidbyte Console (0.0.1b1)
Expand All @@ -32,43 +44,65 @@ Start a pythonic console for testing contracts. Provides web3 and contracts as
Available locals: web3
>>>
## `deploy`
**************
:code:`deploy`
**************

Deploy contracts using the user-written deploy scripts. For more details, see
the [deployment documentation](deployment.md).

## `help`
************
:code:`help`
************

Show usage

## `show`
************
:code:`show`
************

Show details about the deployed contracts

## `version`
***************
:code:`version`
***************

Show versions of solidbyte, the compiler, and associated tools

## `script` [Planning]
**************
:code:`script`
**************

Execute a python script within the context of soidbyte

## `install` [Planning]
***************************
:code:`install` [Prototype]
***************************

Ethereum package registry? https://www.ethpm.com/

## `metafile`
.. _metafile-command:

****************
:code:`metafile`
****************

Commands to backup and cleanup the metafile.

### `metafile cleanup`
========================
:code:`metafile cleanup`
========================

Cleanup and compact `metafile.json` by removing deployed contract instances for test networks.

### `metafile backup`
=======================
:code:`metafile backup`
=======================

Make a copy of `metafile.json` to the given location and verify.

## `sigs`
************
:code:`sigs`
************

Show all event and function signatures for the compiled contracts.
191 changes: 191 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
# -*- 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
sys.path.insert(0, os.path.abspath('..'))


# -- Project information -----------------------------------------------------

project = 'Solidbyte'
copyright = '2019, Mike Shultz'
author = 'Mike Shultz'

# The short X.Y version
version = '0.8'
# The full version, including alpha/beta/rc tags
release = '0.8.2b1'


# -- 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.todo',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
'sphinx.ext.autosectionlabel',
]

intersphinx_mapping = {
'web3': ('https://web3py.readthedocs.io/en/stable/', None),
'pytest': ('https://docs.pytest.org/en/latest/', None),
}

# 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 = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None


# -- 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'

# 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 = 'Solidbytedoc'


# -- 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, 'Solidbyte.tex', 'Solidbyte Documentation',
'Mike Shultz', '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, 'solidbyte', 'Solidbyte 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, 'Solidbyte', 'Solidbyte Documentation',
author, 'Solidbyte', 'One line description of project.',
'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

0 comments on commit 2fee844

Please sign in to comment.