Merge pull request #21 from greschd/add_documentation

Add documentation structure

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
   rev: v0.740
   hooks:
   - id: mypy
-    exclude: '^(doc/)|(examples/)'
+    exclude: '^(docs/)|(examples/)'
 
 - repo: local
   hooks:
@@ -20,7 +20,7 @@ repos:
     entry: prospector
     types: [file, python]
     language: system
-    exclude: '^(doc/)|(examples/)'
+    exclude: '^(docs/)|(examples/)'
 
   - id: version-number
     name: Check version numbers

.readthedocs.yml

@@ -0,0 +1,22 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the doc/ directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

LICENSE.txt

@@ -157,7 +157,7 @@
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
-   Copyright 2019 - 2020 The AIIDA-TESTING authors
+   Copyright 2019 - 2020 The AiiDA Team
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+apidoc/

docs/Makefile

@@ -0,0 +1,41 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -n -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: all help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext customdefault
+
+## Runs with nitty-pick and converting warnings into errors to 
+## make sure the documentation is properly written
+customdefault:
+	$(SPHINXBUILD) -b html -nW $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+all: html
+
+clean:
+	rm -r $(BUILDDIR)
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+
+view:
+	xdg-open $(BUILDDIR)/html/index.html