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 mkdocs #2672

Open
wants to merge 7 commits into
base: devel
Choose a base branch
from
Open

Add mkdocs #2672

wants to merge 7 commits into from

Conversation

nrbnlulu
Copy link

@nrbnlulu nrbnlulu commented Apr 16, 2023

Description

added mkdocs for a better docs experience.

TODO:

  • add link to github example files
  • remove table of content on rendered markdowns.
  • sort tabs by the TOC provided in index.md

GitHub Issues

@codecov
Copy link

codecov bot commented May 29, 2023

Codecov Report

Merging #2672 (d1de503) into devel (e4b1605) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            devel    #2672   +/-   ##
=======================================
  Coverage   91.19%   91.19%           
=======================================
  Files         192      192           
  Lines        7843     7843           
=======================================
  Hits         7152     7152           
  Misses        691      691           

@nrbnlulu nrbnlulu changed the title added mkdocs Add mkdocs Jun 20, 2023
@LecrisUT
Copy link
Contributor

There's a competing PR ar #2478. I think it's helpful to dicuss the merits of one over another at #2709. I'm also putting my hat on the rink for sphinx+rtd

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.

2 participants