Add Sphinx configuration

.github/ISSUE_TEMPLATE/documentation-issue.md

@@ -0,0 +1,34 @@
+---
+name: Documentation Issue
+about: Use this template for documentation related
+title: "[DOC] - Short meaningful description of documentation issue"
+labels: 'Documentation'
+assignees: ''
+
+---
+
+## URL(s) with the issue:
+Please provide a link to the documentation entry.
+
+## Description of issue (what needs changing):
+
+### Clear description
+For example, why should someone use this method? How is it useful?
+
+### Correct links
+Is the link to the source code correct?
+
+### Parameters defined
+Are all parameters defined and formatted correctly?
+
+### Returns defined
+Are return values defined?
+
+### Raises listed and defined
+Are the errors defined?
+
+### Usage example
+Is there a usage example?
+
+### Request visuals, if applicable
+Are there currently visuals? If not, will it clarify the content?

.gitignore

@@ -1,6 +1,268 @@
-/**/.DS_Store
 /**/.vscode
 /**/spa/**/style.css
-/**/node_modules
-/**/package-lock.json
-/**/npm/dist
+
+docs/build
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,solidity,visualstudiocode,react
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,solidity,visualstudiocode,react
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+### react ###
+.DS_*
+logs
+**/*.backup.*
+**/*.back.*
+
+node_modules
+bower_components
+
+*.sublime*
+
+psd
+thumb
+sketch
+
+### Solidity ###
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+
+# End of https://www.toptal.com/developers/gitignore/api/python,solidity,visualstudiocode,react

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing guidelines
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Coding Style](#coding-style)
+  - [Solidity](#solidity)
+  - [JavaScript](#javascript)
+  - [Python](#python)
+- [Documentation](#documentation)
+
+## Coding Style
+
+### Solidity
+
+- Solidity portions of the codebase adhere follow the official [Solidity Styleguide]
+- `.sol` filename should be PascalCase
+
+### JavaScript
+
+### Python
+
+- Python portions of the codebase follow standard PEP8 best practices.
+- Python code must be formatted using the Black formatter using the provided settings.
+
+## Documentation
+
+**NOTE:** Currently the documentation pipeline is composed by a custom Python Parser that output `md`
+files and renders them via `mkdocs`. We are however working on a more comprehensive solution built
+around Sphinx and reStructuredText.
+
+New addition to the codebase must be fully documented.
+
+- JavaScript portions of the code should be annotated using JSDoc style docstrings.
+- Solidity portions of the code should be fully annotated according to [NatSpec] standards.
+
+<!--
+Documentation is generated using Sphinx and reStructuredText, following the example set by Solidity. For a more comprehensive
+description of the documentation process see [Write the Docs!]
+
+To locally generate the documentation:
+
+```console
+virtualenv .venv
+source .venv/bin/activate
+pip install -r docs/requirements.txt
+cd docs
+make html
+``` -->
+
+---
+
+[Solidity Styleguide]: https://solidity.readthedocs.io/en/v0.7.0/style-guide.html
+[NatSpec]: https://solidity.readthedocs.io/en/v0.7.0/style-guide.html#natspec
+[Write the Docs!]: docs/source/write_the_docs.rst
+[Solidity Domain for Sphinx]: https://solidity-domain-for-sphinx.readthedocs.io/en/latest/formatting.html

README.md

@@ -0,0 +1,4 @@
+# dfo-hub
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)