Towards creating a documentation page

.gitignore

@@ -1,3 +1,6 @@
 __pycache__
 
 *.pyc
+examples/*/*/
+
+docs/build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+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)

docs/README.md

@@ -0,0 +1,22 @@
+## Editing, building, and publishing extension documentation
+
+
+[Sphinx](https://www.sphinx-doc.org/en/master/index.html#) is used for document generation.
+
+### Local testing
+
+```
+pip install sphinx sphinx_rtd_theme
+```
+
+Then build the documentation locally:
+
+```
+make -C docs html
+```
+
+Navigate to `docs/build/` and open `index.html`.
+
+### Remote building and testing
+
+The documentation can be automatically build by the GitHub Action can be published within that action.

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx_rtd_theme

docs/source/PASTA/PASTA.rst

@@ -0,0 +1,25 @@
+.. _PASTA:
+
+Screenshots after importing .eln files into PASTA-ELN
+*****************************************************
+
+.. image:: kadi4mat_1.png
+  :width: 600
+  :alt: Screenshot after importing kadi4mat's collections example
+
+.. image:: kadi4mat_2.png
+  :width: 600
+  :alt: Screenshot after importing kadi4mat's records example
+
+.. image:: OpenSemanticLab.png
+  :width: 600
+  :alt: Screenshot after importing OpenSemanticLab's example
+
+.. image:: PASTA.png
+  :width: 600
+  :alt: Screenshot after importing PASTA's example
+
+.. image:: SampleDB.png
+  :width: 600
+  :alt: Screenshot after importing SampleDB's example
+

docs/source/conf.py

@@ -0,0 +1,29 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'The ELN file format'
+copyright = '2024, The ELN Consortium'
+author = 'The ELN Consortium'
+release = '1.1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+html_logo = '_static/Consortium.png'

docs/source/index.rst

@@ -0,0 +1,9 @@
+The ELN file format
+===================
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   PASTA/PASTA