Use more standard docs folder

This commit is contained in:
Luke Murphy
2019-11-25 11:20:53 +07:00
parent f7a5fd0e2a
commit 4062168814
15 changed files with 3 additions and 3 deletions

View File

View File

View File

@ -0,0 +1,5 @@
*********
Changelog
*********
.. include:: ../../CHANGELOG.rst

View File

@ -0,0 +1,6 @@
.. _code-of-conduct:
Code of Conduct
***************
.. include:: ../../CODE_OF_CONDUCT.rst

9
docs/source/conf.py Normal file
View File

@ -0,0 +1,9 @@
author = 'decentral1se'
copyright = '2019, decentral1se'
html_static_path = ['_static']
html_theme = 'sphinx_rtd_theme'
master_doc = 'index'
project = 'hypercore-crypto'
templates_path = ['_templates']
extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints']
autodoc_mock_imports = ['pysodium'] # no libsodium in the RTD environment

View File

@ -0,0 +1,5 @@
**********
Contribute
**********
.. include:: ../../CONTRIBUTING.rst

13
docs/source/example.rst Normal file
View File

@ -0,0 +1,13 @@
.. _example:
*******
Example
*******
.. code-block:: python
from hypercore_crypto import key_pair, sign, verify
public_key, secret_key = key_pair()
signature = sign(b'hello world', secret_key)
verify(message, signature, public_key)

15
docs/source/index.rst Normal file
View File

@ -0,0 +1,15 @@
.. include:: ../../README.rst
:end-before: _documentation
.. toctree::
:maxdepth: 1
:hidden:
install
upgrade
example
modules-api
other-impls
contribute
changelog
code-of-conduct

11
docs/source/install.rst Normal file
View File

@ -0,0 +1,11 @@
************
Installation
************
.. code-block:: bash
$ pip install hypercore-crypto
.. note::
This tool only supports Python >= 3.6.

View File

@ -0,0 +1,8 @@
.. _modules_api:
***********
Modules API
***********
.. automodule:: hypercore_crypto.crypto
:members:

View File

@ -0,0 +1,11 @@
.. _other-implementations:
*********************
Other Implementations
*********************
* `mafintosh/hypercore-crypto`_
* `datcxx/hypercore-crypto`_
.. _mafintosh/hypercore-crypto: https://github.com/mafintosh/hypercore-crypto
.. _datcxx/hypercore-crypto: https://github.com/datcxx/hypercore-crypto

7
docs/source/upgrade.rst Normal file
View File

@ -0,0 +1,7 @@
*******
Upgrade
*******
.. code-block:: bash
$ pip install --upgrade hypercore-crypto