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

Add old oep-code documentation to new docs #1303

Draft
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

jh-RLI
Copy link
Contributor

@jh-RLI jh-RLI commented Jul 12, 2023

Summary of the discussion

We want to ease the creation of documentation by writing google-style docstrings and markdown.
Also, we reduce the 3rd party deps. by stepping back from ReadTheDocs platform.

Type of change (CHANGELOG.md)

Added

  • Rework the Documentation and introduce mkdocs + material + mkdocstrings (#)

Workflow checklist

Automation

Closes #1277

PR-Assignee

Reviewer

  • 🐙 Follow the Reviewer Guidelines
  • 🐙 Provided feedback and show sufficient appreciation for the work done

@jh-RLI jh-RLI self-assigned this Jul 12, 2023
@jh-RLI jh-RLI mentioned this pull request Jul 13, 2023
@jh-RLI jh-RLI changed the title migrate documentation to mkdocs Add complete documentation to new docs Aug 10, 2023
@jh-RLI jh-RLI changed the title Add complete documentation to new docs Add complete oep-code documentation to new docs Aug 10, 2023
@jh-RLI jh-RLI changed the title Add complete oep-code documentation to new docs Add old oep-code documentation to new docs Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate to mkdocs
1 participant