pasta-eln 2.5.0b7__tar.gz

pasta_eln-2.5.0b7/LICENSE

@@ -0,0 +1,32 @@
+PASTA-ELN and all its subparts is covered by the MIT license.
+
+  The MIT License
+
+  Copyright (c) 2022- Steffen Brinckmann
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
+
+
+This software uses a number of different libraries, some of which are made available
+under different open-source licenses (e.g. LGPL-3.0). Please check the relevant licenses before
+using and/or modifying those libraries.
+
+
+Most of the file-layout and the integration of webservices follows the example of datalad and datalad-gooey
+https://github.com/datalad. We thank those developers for their work and contribution to free software.

pasta_eln-2.5.0b7/MANIFEST.in

@@ -0,0 +1,7 @@
+graft pasta_eln
+graft docs
+prune docs/build
+global-exclude *.py[cod]
+
+include pasta_eln/Resources/ExampleMeasurements/*
+include pasta_eln/Resources/Icons/*

pasta_eln-2.5.0b7/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: pasta_eln
+Version: 2.5.0b7
+Summary: The favorite ELN for experimental scientists
+Home-page: https://pasta-eln.github.io/
+Author: The PASTA-ELN Team and Steffen Brinckmann
+Author-email: sbrinckm@gmail.com
+License: MIT
+Classifier: Programming Language :: Python
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: pyside6==6.2.4
+Requires-Dist: qt-material
+Requires-Dist: QtAwesome
+Requires-Dist: cloudant
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: keyring
+Requires-Dist: requests
+Requires-Dist: anytree
+Requires-Dist: qrcode
+Requires-Dist: Pillow
+Requires-Dist: matplotlib
+Requires-Dist: cairosvg
+Requires-Dist: win-unicode-console; platform_system == "Windows"
+Requires-Dist: winshell; platform_system == "Windows"
+Requires-Dist: pypiwin32; platform_system == "Windows"
+Requires-Dist: aiohttp
+Provides-Extra: devel
+Requires-Dist: sphinx; extra == "devel"
+Requires-Dist: sphinx-rtd-theme; extra == "devel"
+Requires-Dist: pytest; extra == "devel"
+Requires-Dist: pytest-cov; extra == "devel"
+Requires-Dist: pytest-qt; extra == "devel"
+Requires-Dist: pytest-xvfb; extra == "devel"
+Requires-Dist: pytest-mock; extra == "devel"
+Requires-Dist: coverage; extra == "devel"
+Requires-Dist: pyqt6; extra == "devel"
+Requires-Dist: pyqt6-tools; extra == "devel"
+Requires-Dist: scalene; extra == "devel"
+
+
+[![PyPI version](https://badge.fury.io/py/pasta-eln.svg)](https://badge.fury.io/py/pasta-eln)
+[![GitHub version](https://badge.fury.io/gh/PASTA-ELN%2Fpasta-eln.svg)](https://badge.fury.io/gh/PASTA-ELN%2Fpasta-eln)
+[![PyPi build](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pypi.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pypi.yml)
+[![Verify Linux install](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/installLinux.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/installLinux.yml)
+[![Documentation building](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/docbuild.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/docbuild.yml)
+[![Linting](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pylint.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pylint.yml)
+[![MyPy](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/mypy.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/mypy.yml)
+
+# PASTA electronic lab notebook (ELN) | The favorite ELN for experimental scientists
+
+Pasta-dishes are a mixture pasta and sauce, the latter adds flavors and richness to the otherwise boring pasta. This ELN combines raw-data with rich metadata to allow advanced data science. In the database, one can fully adapt and improvise the metadata definitions to generate something novel. PASTA-ELN uses a local-first approach: store all data and metadata locally (always accessible to user) and synchronize with a server upon user request.
+
+## Location of information
+More information, incl. detailed installation instructions, for users can be found on the [Github-pages](https://pasta-eln.github.io/pasta-eln/).
+
+While people that are interested into the development are guided to [github](https://github.com/PASTA-ELN/pasta-eln/).
+
+## Short installation instructions
+``` bash
+pip install pasta-eln
+```
+
+To start PASTA-ELN, use:
+``` bash
+pastaELN
+```
+which will automatically open the graphical user interface (GUI) to finish the setup.
+
+More detail are found at the [install-page](https://pasta-eln.github.io/pasta-eln/install.html).

pasta_eln-2.5.0b7/README.md

@@ -0,0 +1,134 @@
+
+[![PyPI version](https://badge.fury.io/py/pasta-eln.svg)](https://badge.fury.io/py/pasta-eln)
+[![GitHub version](https://badge.fury.io/gh/PASTA-ELN%2Fpasta-eln.svg)](https://badge.fury.io/gh/PASTA-ELN%2Fpasta-eln)
+[![PyPi build](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pypi.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pypi.yml)
+[![Verify Linux install](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/installLinux.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/installLinux.yml)
+[![Documentation building](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/docbuild.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/docbuild.yml)
+[![Linting](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pylint.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pylint.yml)
+[![MyPy](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/mypy.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/mypy.yml)
+
+# PASTA-ELN | The favorite ELN for experimental scientists
+
+> :warning: **Users: all documentation can be found at [Github-pages](https://pasta-eln.github.io/pasta-eln/)**
+>
+> **This page / area is for developers and contains some helpful information for them**
+
+---
+
+## Developers: notes on windows installation
+
+### How to start Pasta ELN
+- Anaconda
+  - python -m pasta_eln.gui
+  - DOES NOT WORK "pastaELN"
+
+### Installation location windows:
+- Default installation
+  - C:\Users\...\AppData\Local\Programs\Python\Python311\Scripts
+  - C:\Users\...\AppData\Local\Programs\Python\Python311\Lib\site-packages\pasta_eln
+- Anaconda
+  - C:\Users\...\anaconda3\envs\...\Scripts>
+  - C:\Users\...\anaconda3\envs\...\Lib\site-packages\pasta_eln
+
+### Reinstall /retry windows installation
+- uninstall couchdb in Settings
+- remove directories
+  - **C:\Program Files\Apache CouchDB**
+  - C:\Users\....\AppData\Local\Programs\Python [If deleted python]
+  - Pasta-Folder in Documents
+- remove Users\...\.pastaELN.json
+- remove shortcut on Windows desktop
+- restart Windows
+- **python -m pasta_eln.gui**
+- go through steps and wait for restart
+- after restart go to System->Configuration (ctrl-0) ->Setup-> start again
+  - or have a separate button for that
+
+---
+
+## Developers: notes on linux installation
+### Installation location:
+- Default
+  - /usr/local/lib/python3.10/dist-packages/pasta_eln
+
+### Restart installation on linux / ubuntu
+``` bash
+rm .pastaELN.json pastaELN.log
+rm -rf pastaELN/PastasExampleProject pastaELN/StandardOperatingProcedures
+sudo snap stop couchdb
+sudo snap remove couchdb
+```
+
+---
+## Test couchDB running
+- CouchDB at HTTP! [http://127.0.0.1:5984/_utils/#login](http://127.0.0.1:5984/_utils/#login)
+- curl -f http://127.0.0.1:5984/
+- curl -X POST -H "Content-Type: application/json; charset=utf-8" -d '{"name": "*+*", "password": "*+*"}' http://127.0.0.1:5984/_session
+
+
+## Notes on all systems
+Run Pasta-ELN directly from commandline without installation
+- python3 -m pasta_eln.gui
+- python3 -m pasta_eln.installationTools
+- python3 -m pasta_eln.Tests.3Projects
+- pastaELN.py in home directory of repository
+
+---
+
+## How to write code
+### How to write small python programs that do things
+#### Backend
+``` Python
+from pasta_eln.backend import Pasta
+pasta = Pasta()
+viewProj = pasta.db.getView('viewDocType/x0')
+projID1  = [i['id'] for i in viewProj if 'PASTA' in i['value'][0]][0]
+pasta.changeHierarchy(projID1)
+print(pasta.outputHierarchy())
+```
+
+#### Frontend
+For testing WIDGETS put this code into "pasta_eln/test.py":
+``` Python
+from PySide6.QtWidgets import QApplication, QMainWindow
+from .backend import Backend
+from .communicate import Communicate
+from .widgetDetails import Details
+
+class MainWindow(QMainWindow):
+  def __init__(self):
+    super().__init__()
+    self.backend = Backend()
+    comm = Communicate(self.backend)
+    widget = Details(comm)
+    self.setCentralWidget(widget)
+    comm.changeDetails.emit('m-a23019163b9c4fccb4edaab0feb2b5ee')
+
+app = QApplication()
+window = MainWindow()
+window.show()
+app.exec()
+```
+and execute "python -m pasta_eln.test"
+
+For testing DIALOGS put this code into "pasta_eln/test.py":
+``` Python
+import sys
+from PySide6.QtWidgets import QApplication
+from .GUI.form import Form
+from .backend import Backend
+from .guiCommunicate import Communicate
+
+app = QApplication(sys.argv)
+backend = Backend()
+comm = Communicate(backend)
+doc = backend.db.getDoc("m-3a43570c4fd84b1ab81a8863ae058fb0")
+dialog = Form(comm, doc)
+dialog.show()
+sys.exit(app.exec())
+```
+and execute "python -m pasta_eln.test"
+
+#### General notes
+- Find qt-awesome icons: qta-browser
+- print works great in frondend and backend

pasta_eln-2.5.0b7/README_PYPI.md

@@ -0,0 +1,30 @@
+
+[![PyPI version](https://badge.fury.io/py/pasta-eln.svg)](https://badge.fury.io/py/pasta-eln)
+[![GitHub version](https://badge.fury.io/gh/PASTA-ELN%2Fpasta-eln.svg)](https://badge.fury.io/gh/PASTA-ELN%2Fpasta-eln)
+[![PyPi build](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pypi.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pypi.yml)
+[![Verify Linux install](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/installLinux.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/installLinux.yml)
+[![Documentation building](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/docbuild.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/docbuild.yml)
+[![Linting](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pylint.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/pylint.yml)
+[![MyPy](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/mypy.yml/badge.svg)](https://github.com/PASTA-ELN/pasta-eln/actions/workflows/mypy.yml)
+
+# PASTA electronic lab notebook (ELN) | The favorite ELN for experimental scientists
+
+Pasta-dishes are a mixture pasta and sauce, the latter adds flavors and richness to the otherwise boring pasta. This ELN combines raw-data with rich metadata to allow advanced data science. In the database, one can fully adapt and improvise the metadata definitions to generate something novel. PASTA-ELN uses a local-first approach: store all data and metadata locally (always accessible to user) and synchronize with a server upon user request.
+
+## Location of information
+More information, incl. detailed installation instructions, for users can be found on the [Github-pages](https://pasta-eln.github.io/pasta-eln/).
+
+While people that are interested into the development are guided to [github](https://github.com/PASTA-ELN/pasta-eln/).
+
+## Short installation instructions
+``` bash
+pip install pasta-eln
+```
+
+To start PASTA-ELN, use:
+``` bash
+pastaELN
+```
+which will automatically open the graphical user interface (GUI) to finish the setup.
+
+More detail are found at the [install-page](https://pasta-eln.github.io/pasta-eln/install.html).

pasta_eln-2.5.0b7/docs/Makefile

@@ -0,0 +1,193 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -W
+SPHINXBUILD   = python3 -m sphinx
+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   = -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: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/* source/generated source/_extras/schema.json
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/datalad_gooey.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/datalad_gooey.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/datalad_gooey"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/datalad_gooey"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	@echo start man
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

pasta_eln-2.5.0b7/docs/README.md

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