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 html_meta to all doc/.md #327

Closed
wants to merge 10 commits into from
Closed

Add html_meta to all doc/.md #327

wants to merge 10 commits into from

Conversation

Sohlar
Copy link
Contributor

@Sohlar Sohlar commented Mar 20, 2023

Describe your changes

  • Add description, language, and keywords metadata tags to all .md files in doc directory
  • Remove empty metadata tag lists in feature_selection.md
  • Black formatting in doc/optimization/.
  • Update Jupytext version

#TODO: .rst files

Issue ticket number and link

Partially Closes #290

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have added thorough tests (when necessary).
  • I have added the right documentation in the docstring and changelog (when needed)

📚 Documentation preview 📚: https://sklearn-evaluation--327.org.readthedocs.build/en/327/

Added meta directives to .md files in doc/(classification & comparison).

Good place to start and discuss potential changes.
Added meta directives to .md files in doc/(classification & comparison).

Good place to start and discuss potential changes.

Update README.md

Lint & Format docs

Added meta tags for SEO
@idomic
Copy link
Contributor

idomic commented Mar 20, 2023

@Sohlar tag when ready for review!
Also I think the CI is failing on the docs, please fix.

@coveralls
Copy link

coveralls commented Mar 20, 2023

Pull Request Test Coverage Report for Build 4563170126

Warning: This coverage report may be inaccurate.

We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
To ensure accuracy in future PRs, please see these guidelines.
A quick fix for this PR: rebase it; your next report should be accurate.

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 15 unchanged lines in 4 files lost coverage.
  • Overall coverage increased (+0.05%) to 91.718%

Files with Coverage Reduction New Missed Lines %
src/sklearn_evaluation/plot/precision_recall.py 1 98.51%
src/sklearn_evaluation/plot/plot.py 2 72.73%
src/sklearn_evaluation/plot/calibration.py 6 93.02%
src/sklearn_evaluation/plot/roc.py 6 95.11%
Totals Coverage Status
Change from base Build 4469212696: 0.05%
Covered Lines: 3555
Relevant Lines: 3876

💛 - Coveralls

@edublancas
Copy link
Contributor

note that due to an update in jupyter-book, the html_meta has to appear under the myst section: https://github.com/ploomber/contributing/blob/main/documentation/seo.md

Also if you're the formatting tool, ensure you add notebook_metadata_filter: myst to the metadata, otherwise the metadata is deleted (this is a bug we recently discovered)

more info here: https://github.com/ploomber/contributing/blob/main/documentation/notebooks.md

@edublancas
Copy link
Contributor

FYI: the docs started failing due to an unrelated reason #329 we can either wait for a fix or merge without a doc preview

Added a myst section for html_meta to all .md.

Added notebook metadata filter for myst.
@Sohlar Sohlar marked this pull request as ready for review March 30, 2023 14:35
@Sohlar Sohlar closed this Apr 18, 2023
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.

add missing html_meta to every .md/.rst document
4 participants