Switched to mkdocs. Updated introduction. #699

.dockerignore

@@ -27,7 +27,7 @@ dependencies/**/tests
 dependencies/**/regtests
 dependencies/parsers/phonopy-library/example*
 
-docs/.build
+site
 docs/*.graffle
 
 nomad/normalizing/data/*.db

.gitignore

@@ -44,3 +44,5 @@ jupyterhub_cookie_secret
 jupyterhub.sqlite
 jupyterhub-proxy.pid
 gui/src/parserMetadata.json
+site/
+docs/*.graffle
\ No newline at end of file

Dockerfile

@@ -70,8 +70,7 @@ COPY . /install
 RUN python setup.py compile
 RUN pip install .[all]
 RUN ./generate_gui_artifacts.sh
-WORKDIR /install/docs
-RUN make html
+RUN mkdocs build && mv site docs/build
 RUN \
     find /usr/local/lib/python3.7/ -name 'tests' ! -path '*/networkx/*' -exec rm -r '{}' + && \
     find /usr/local/lib/python3.7/ -name 'test' -exec rm -r '{}' + && \
@@ -104,7 +103,7 @@ WORKDIR /app
 # transfer installed packages from dependency stage
 COPY --from=build /usr/local/lib/python3.7/site-packages /usr/local/lib/python3.7/site-packages
 # copy the documentation, its files will be served by the API
-COPY --from=build /install/docs/.build /app/docs/.build
+COPY --from=build /install/docs/build /app/docs/build
 # copy the nomad command
 COPY --from=build /usr/local/bin/nomad /usr/bin/nomad
 # copy the gui

docs/.gitignore

-.DS_Store
-.build/
-*.graffle/
-react-docgen.out
\ No newline at end of file

docs/.static/css/custom.css

-body {
-    font-family: "Roboto", "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif;
-}
-
-
-h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend {
-    font-family: inherit !important
-}
-
-.wy-nav-top {
-    display: none
-}
-
-/* a {
-    color: #607D8B !important
-}
-
-a:visited {
-    color: #607D8B !important
-} */
\ No newline at end of file

docs/Makefile

-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = NOMAD
-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)
\ No newline at end of file

docs/aitoolkit.md

+go here ..
\ No newline at end of file

docs/api.md

@@ -130,4 +130,4 @@ print(json.dumps(data), indent=2)
 
 This library is part devevloped by NOMAD. It is supposed to provide more powerful
 access to common yet complex tasks. It currently only support access to the NOMAD
-Archive. It has its separate documentation [here](archive.html).
\ No newline at end of file
+Archive. It has its separate documentation [here](pythonlib).
\ No newline at end of file

docs/archive.rst

-.. _access-the-archive-label:
-
-Data Access (Archive)
-=====================
-
-Of course, you can access the NOMAD Archive directly via the NOMAD API (see the `API tutorial <api_tutorial.html>`_
-and `API reference <api.html>`_). But, it is more effective and convenient to use NOMAD's Python client
-library.
-
-.. automodule:: nomad.client.archive