deploy: a3fcc5d

nfdi4cat · Jan 7, 2025 · 32795b8 · 32795b8
commit 32795b8
Show file tree

Hide file tree

Showing 73 changed files with 7,327 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6a9dcb63ce67391a084adb1798b36089
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/maintenance/creating-docs-locally.doctree b/.doctrees/maintenance/creating-docs-locally.doctree
diff --git a/.doctrees/maintenance/handling-something.doctree b/.doctrees/maintenance/handling-something.doctree
diff --git a/.doctrees/usage/about.doctree b/.doctrees/usage/about.doctree
diff --git a/.doctrees/usage/guidelines.doctree b/.doctrees/usage/guidelines.doctree
diff --git a/.doctrees/usage/how-to-contribute.doctree b/.doctrees/usage/how-to-contribute.doctree
diff --git a/.doctrees/usage/how-to-use.doctree b/.doctrees/usage/how-to-use.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/404.html b/404.html
@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="pandoc" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <title>404</title>
+  <style>
+    h1 {
+      color: #005A9C;
+      font: 200% sans-serif;
+      text-align: center
+    }
+    body {
+      padding: 2em;
+      font-family: sans-serif;
+      text-align: center;
+    }
+  </style>
+</head>
+<body>
+  <h1 id="section">404</h1>
+  <p>We couldn’t find the page you are looking for.</p>
+  <p>Check out:</p>
+  <p>
+    <a href="https://nfdi4cat.github.io/repo4cat/"><img src="https://img.shields.io/static/v1?label=repo4cat&amp;message=index%20of%20pages&amp;color=green&amp;logo=github"   alt="repo4cat - documentation hub" /></a>
+    <a href="https://github.com/nfdi4cat/repo4cat"><img src="https://img.shields.io/static/v1?label=repo4cat&amp;message=repository&amp;color=blue&amp;logo=github" alt="repo4cat - GitHub repository" /></a>
+  </p>
+  </body>
+</html>
diff --git a/_images/dechema.png b/_images/dechema.png
diff --git a/_images/dfg.png b/_images/dfg.png
diff --git a/_images/fig_A.svg b/_images/fig_A.svg
diff --git a/_images/fig_B.svg b/_images/fig_B.svg
diff --git a/_images/fig_C.svg b/_images/fig_C.svg
diff --git a/_sources/index.md.txt b/_sources/index.md.txt
@@ -0,0 +1,77 @@
+---
+hide-toc: true
+---
+
+# Documentation Hub
+
+This is work in progress...
+
+::::{grid} 3
+:::{grid-item-card}
+:link: https://github.com/nfdi4cat/repo4cat/
+**Link A**, Anna
+^^^
+
+```{image} _static/fig_A.svg
+:align: center
+:alt: screenshot of documentation
+```
+
++++
+<small>Most current</small>
+:::
+
+:::{grid-item-card}
+:link: https://github.com/nfdi4cat/repo4cat/
+**Link B**, Berta
+^^^
+
+```{image} _static/fig_B.svg
+:align: center
+:alt: screenshot of file
+```
++++
+<small>Download to contribute</small>
+:::
+
+:::{grid-item-card}
+:link: https://w3id.org/nfdi4cat/repo4cat/
+**Link C**, Charla
+^^^
+
+```{image} _static/fig_C.svg
+:align: center
+:alt: screenshot of file 3
+```
+
++++
+<small>Download to contribute</small>
+:::
+::::
+
+More text ....
+
+```{toctree}
+:hidden:
+Overview <self>
+GitHub page <https://github.com/nfdi4cat/repo4cat>
+About <usage/about>
+```
+
+```{toctree}
+:caption: For Users
+:hidden:
+:maxdepth: 2
+
+usage/how-to-use
+usage/how-to-contribute
+usage/guidelines
+```
+
+```{toctree}
+:caption: For Maintainers
+:glob:
+:hidden:
+
+maintenance/*
+```
diff --git a/_sources/maintenance/creating-docs-locally.md.txt b/_sources/maintenance/creating-docs-locally.md.txt
@@ -0,0 +1,28 @@
+# Building the documentation locally
+
+You need a recent Python version on your computer and a local clone of the repository.
+
+The following commands should be run from the root directory of the clone.
+
+First, install the required packages into a virtual environment. The documentation is built with Sphinx and MyST for markdown support.
+
+```bat
+py -m venv .venv
+.venv\Scripts\activate
+pip install -r docs\requirements.txt
+```
+
+Build the documentation (option `-a` tells sphinx to rebuild all files, `--nitpicky` warns on missing references):
+
+```bat
+sphinx-build -a --nitpicky docs docs/_build
+```
+
+Alternatively you can use the `make` command in the `docs`-folder to build the documentation:
+
+```bat
+cd docs
+make html
+```
+
+The documentation is created in `docs/_build` and can be previewed by opening the file `docs\_build\html\index.html` in a web browser.
diff --git a/_sources/maintenance/handling-something.md.txt b/_sources/maintenance/handling-something.md.txt
@@ -0,0 +1,6 @@
+# Handling of Something
+
+```{note} This guide is only relevant for maintainers with commit rights.
+```
+
+To update ...
diff --git a/_sources/usage/about.md.txt b/_sources/usage/about.md.txt
@@ -0,0 +1,25 @@
+# About Repo4Cat
+
+**FUNDING**
+
+<img src="./media/dfg.png" alt="DFG logo" />
+
+This work was funded by the German Research Foundation (DFG) through the project "[NFDI4Cat](https://nfdi4cat.org/) - NFDI for Catalysis-Related
+Sciences" (DFG project no. [441926934](https://gepris.dfg.de/gepris/projekt/441926934)),
+within the National Research Data Infrastructure ([NFDI](https://www.nfdi.de/)) programme of the Joint Science Conference (GWK).
+
+**CONTACT for NFDI4Cat**
+
+<img src="./media/dechema.png" alt="DECHEMA e.V. logo" />
+
+DECHEMA Gesellschaft für Chemische Technik und Biotechnologie e.V.
+Theodor-Heuss-Allee 25
+D–60486 Frankfurt am Main
+
+Phone: 0049-69-7564-0
+Fax: 0049-69-7564-117
+
+Dr. Sara Espinoza
+
+e-mail: sara.espinoza@dechema.de  
+Internet: https://www.dechema.de
diff --git a/_sources/usage/guidelines.md.txt b/_sources/usage/guidelines.md.txt
@@ -0,0 +1,3 @@
+# Guidelines for Data Formats
+
+Tbw...
diff --git a/_sources/usage/how-to-contribute.md.txt b/_sources/usage/how-to-contribute.md.txt
@@ -0,0 +1,7 @@
+# How to contribute to Repo4Cat?
+
+```{todo}
+Move and merge documentation from various places to this page.
+
+We should maybe also add a section about how to contribute to this dcoumentation.
+```
diff --git a/_sources/usage/how-to-use.md.txt b/_sources/usage/how-to-use.md.txt
@@ -0,0 +1,7 @@
+# How to work with Repo4Cat?
+
+```{todo} Possible topics:
+* tba
+
+What other topics would you like to read about here? Let us know by [creating an issue](https://github.com/nfdi4cat/repo4cat/issues/new)!
+```