Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Files for field DOCUMENTATION are missing #4

Closed
8 tasks done
Ludee opened this issue Mar 3, 2022 · 5 comments · Fixed by #14 or #25
Closed
8 tasks done

Files for field DOCUMENTATION are missing #4

Ludee opened this issue Mar 3, 2022 · 5 comments · Fixed by #14 or #25
Assignees
Labels
other: help wanted 🙋 Help or assistance is needed part: docu 📖 Improvements or additions to documentation priority: high ⚡ High priority type: enhancement ⚙️ Improvement of an existing feature type: feature 🛠️ New feature or request

Comments

@Ludee
Copy link
Member

Ludee commented Mar 3, 2022

DOCUMENTATION

Additional

  • requirements.txt to ease environment installation
@Ludee Ludee added part: docu 📖 Improvements or additions to documentation type: enhancement ⚙️ Improvement of an existing feature other: help wanted 🙋 Help or assistance is needed labels Mar 3, 2022
@Ludee Ludee added this to the Complete repository milestone Mar 3, 2022
@Ludee Ludee self-assigned this Mar 3, 2022
Ludee added a commit that referenced this issue Mar 3, 2022
Ludee added a commit that referenced this issue Mar 3, 2022
Ludee added a commit that referenced this issue Mar 3, 2022
Ludee added a commit that referenced this issue Mar 3, 2022
@Ludee Ludee mentioned this issue Mar 3, 2022
Ludee added a commit that referenced this issue Mar 3, 2022
Ludee added a commit that referenced this issue May 9, 2022
Ludee added a commit that referenced this issue May 9, 2022
@Ludee Ludee mentioned this issue Aug 18, 2022
@jh-RLI
Copy link
Contributor

jh-RLI commented Oct 31, 2022

Within the next weeks (probably next week) I will be able to provide detailed information on what documentation tool we should use here. Still in favor of:

  1. mkdocs for basic "not so shiny" technical documentation (based on python - best option for pure python software)
  2. docsaurus for a shiny look and more interactive UI for technical + general documentation (based on node.js - very common in many projects globally - not that common in rli projects - still easy to install and manage)

@Ludee
Copy link
Member Author

Ludee commented Jan 5, 2023

We decided for mkdocs as default documentation package and material as default style.
https://pypi.org/project/mkdocs/
https://pypi.org/project/mkdocs-material/
https://squidfunk.github.io/mkdocs-material/

@Ludee Ludee linked a pull request Jan 5, 2023 that will close this issue
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Jan 5, 2023
Ludee added a commit that referenced this issue Feb 17, 2023
Add mkdocstrings plugin and add usage example #4
Ludee added a commit that referenced this issue Feb 20, 2023
Ludee added a commit that referenced this issue Feb 20, 2023
@Ludee
Copy link
Member Author

Ludee commented Feb 20, 2023

For publishing and deploying the documentation on a GitHub Page with an GitHub Action this file is necessary:

  • .github\workflows\gh-pages.yml

Ludee added a commit that referenced this issue Feb 20, 2023
Ludee added a commit that referenced this issue Feb 20, 2023
Ludee added a commit that referenced this issue Feb 20, 2023
Ludee added a commit that referenced this issue Feb 20, 2023
@Ludee Ludee linked a pull request Feb 20, 2023 that will close this issue
5 tasks
Ludee added a commit that referenced this issue Feb 20, 2023
Ludee added a commit that referenced this issue Feb 20, 2023
Ludee added a commit that referenced this issue May 4, 2023
Ludee added a commit that referenced this issue May 4, 2023
@jh-RLI jh-RLI self-assigned this Aug 9, 2023
@Ludee Ludee added type: feature 🛠️ New feature or request priority: high ⚡ High priority labels Aug 17, 2023
Ludee added a commit that referenced this issue Aug 17, 2023
@Ludee
Copy link
Member Author

Ludee commented Nov 27, 2024

Versions in MkDocs are done with mike. They need to be set manually after the release.
The develop branch is build using the workflow gh-pages.yml

@Ludee Ludee closed this as completed Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
other: help wanted 🙋 Help or assistance is needed part: docu 📖 Improvements or additions to documentation priority: high ⚡ High priority type: enhancement ⚙️ Improvement of an existing feature type: feature 🛠️ New feature or request
Projects
None yet
2 participants