diff --git a/.gitignore b/.gitignore index b6e4761..4aea25f 100644 --- a/.gitignore +++ b/.gitignore @@ -118,7 +118,7 @@ venv.bak/ .ropeproject # mkdocs documentation -/site +/super-docs/site # mypy .mypy_cache/ diff --git a/docs/collaboration/citation.md b/docs/collaboration/citation.md new file mode 100644 index 0000000..c801953 --- /dev/null +++ b/docs/collaboration/citation.md @@ -0,0 +1,3 @@ +# Citation + +See the *Cite this repository* function or [CITATION.cff](https://github.com/rl-institut/super-repo/blob/develop/CITATION.cff) for citation of this repository. \ No newline at end of file diff --git a/docs/collaboration/code_of_conduct.md b/docs/collaboration/code_of_conduct.md new file mode 100644 index 0000000..6454067 --- /dev/null +++ b/docs/collaboration/code_of_conduct.md @@ -0,0 +1,4 @@ +# Code of Conduct + +This repository is following the [Contributor Covenant Code of Conduct](https://github.com/rl-institut/super-repo/blob/production/CODE_OF_CONDUCT.md).
+Everyone is asked to be self-reflective and always maintain a good culture of discussion and active participation. diff --git a/docs/collaboration/contributing.md b/docs/collaboration/contributing.md new file mode 100644 index 0000000..5488740 --- /dev/null +++ b/docs/collaboration/contributing.md @@ -0,0 +1,6 @@ +# Contributing + +This software is licensed under an open-source license and can be downloaded, +executed and modified.
+To contribute to the collaborative development follow the workflow described in +[CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md). \ No newline at end of file diff --git a/docs/collaboration/index.md b/docs/collaboration/index.md new file mode 100644 index 0000000..e67ec8e --- /dev/null +++ b/docs/collaboration/index.md @@ -0,0 +1,4 @@ +# Collaboration + +This open-source software is a collaborative effort.
+The repository has several elements to provide necessary functions. diff --git a/docs/collaboration/license.md b/docs/collaboration/license.md new file mode 100644 index 0000000..99f9d34 --- /dev/null +++ b/docs/collaboration/license.md @@ -0,0 +1,4 @@ +# License + +This software is developed under an [open-source license](https://en.wikipedia.org/wiki/Open-source_license).
+The selected license can be read in the [LICENSE.txt](https://github.com/rl-institut/super-repo/blob/develop/LICENSE.txt). diff --git a/docs/collaboration/users.md b/docs/collaboration/users.md new file mode 100644 index 0000000..11d8d8f --- /dev/null +++ b/docs/collaboration/users.md @@ -0,0 +1,3 @@ +# Users + +Known user of this software can be added to [USERS.cff](https://github.com/rl-institut/super-repo/blob/develop/USERS.cff) for reference. \ No newline at end of file diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..a9146c8 --- /dev/null +++ b/docs/css/extra.css @@ -0,0 +1,7 @@ +:root > * { + --md-primary-fg-color: #0f3b64; + --md-primary-fg-color--dark: #5d6cc0; + --md-typeset-a-color: #5ba6ec; + /* --md-text-font-color: #ffffff; */ + /* --md-primary-fg-color--light: #ECB7B7; */ + } \ No newline at end of file diff --git a/docs/documentation/index.md b/docs/documentation/index.md new file mode 100644 index 0000000..f6d1716 --- /dev/null +++ b/docs/documentation/index.md @@ -0,0 +1,19 @@ +# Documentation + +- README.rst +- CHANGELOG.md +- docs/ +- MkDocs +- mkdocstrings + + +## MkDocs + +`pip install mkdocs` install MkDocs
+`pip install mkdocs-material` install the material theme
+`mkdocs serve` start the local live version of the documentation + +`mkdocs build` build the documentation + +Publish MkDocs project on github pages (requires permissions on repository)
+`mkdocs gh-deploy` manually deploy the local docs files to github pages diff --git a/docs/git/index.md b/docs/git/index.md new file mode 100644 index 0000000..41c0ba3 --- /dev/null +++ b/docs/git/index.md @@ -0,0 +1,7 @@ +# Git + +- .gitignore +- .github +- issue_template +- pull_request_template +- workflows (testing) diff --git a/docs/img/logo_oefamily_small.png b/docs/img/logo_oefamily_small.png new file mode 100644 index 0000000..49e4bd0 Binary files /dev/null and b/docs/img/logo_oefamily_small.png differ diff --git a/docs/img/logo_rli_small.png b/docs/img/logo_rli_small.png new file mode 100644 index 0000000..06a2f6c Binary files /dev/null and b/docs/img/logo_rli_small.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..0eb63d2 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,22 @@ +--- +hide: + - footer + - toc +--- + +# Welcome to the Super-Repo Documentation + +A template repo to test and document elements and features for research software.
+It implements the collection of repository elements and files.
+The goal is to simplify and standardise the creation of software in GitHub repositories. + +## Fields for development: + +- COLLABORATION +- GIT +- DOCUMENTATION +- INSTALL +- CODE-STYLE +- TESTS +- LOGGING +- RELEASE diff --git a/docs/install/index.md b/docs/install/index.md new file mode 100644 index 0000000..5706ee1 --- /dev/null +++ b/docs/install/index.md @@ -0,0 +1,7 @@ +# Install + +- requirements.txt +- requirements_dev.txt +- environment.yml +- setup.py +- pyproject.toml diff --git a/docs/release/index.md b/docs/release/index.md new file mode 100644 index 0000000..2a4cc1a --- /dev/null +++ b/docs/release/index.md @@ -0,0 +1,6 @@ +# Release + +- RELEASE_PROCEDURE.md +- VERSION +- MANIFEST.in +- .bumpversion.cfg diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..a8cc0e6 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,64 @@ +# Project +site_name: Super-Repo Documentation +site_url: +site_description: Write your documentation in Markdown and create a static page for your developer and user community + +# Repository +repo_name: rl-institut/super-repo +repo_url: https://github.com/rl-institut/super-repo +docs_dir: docs + +# Configuration +theme: + name: material + logo: img/logo_rli_small.png + palette: + # Palette toggle for dark mode + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + # Palette toggle for light mode + - scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + icon: + repo: fontawesome/brands/github + features: + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + - navigation.indexes + - navigation.path + - navigation.tracking + - navigation.top + - toc.follow + +# Customization +extra: + generator: false + +extra_css: + - css/extra.css + +# Navigation +nav: + - Home: index.md + - Development: + - Collaboration: + - collaboration/index.md + - License: collaboration/license.md + - Citation: collaboration/citation.md + - Contributing: collaboration/contributing.md + - Users: collaboration/users.md + - Code of Conduct: collaboration/code_of_conduct.md + - Git: + - git/index.md + - Documentation: + - documentation/index.md + - Release: + - release/index.md + - Code Documentation: + - Install: + - install/index.md