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

Fix broken references in documentation #1058

Merged
merged 3 commits into from
Jun 1, 2022

Conversation

GandalfDG
Copy link
Contributor

So far I have eliminated 180 warnings about missing reference targets by adding a currentmodule directive to examples.rst. This was an easy fix, but I will continue to chip away at broken references. Also, it might be good to add nitpicky warning output from sphinx-build to the CI process to ensure high-quality documentation

this fix eliminates a ton of broken links from the
examples page of the documentation
@codecov
Copy link

codecov bot commented Apr 20, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.32%. Comparing base (6ae673a) to head (02fa078).
Report is 352 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1058   +/-   ##
=======================================
  Coverage   96.32%   96.32%           
=======================================
  Files          40       40           
  Lines        9407     9407           
  Branches     1248     1248           
=======================================
  Hits         9061     9061           
  Misses        204      204           
  Partials      142      142           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@GandalfDG GandalfDG marked this pull request as ready for review April 28, 2022 15:07
@jmwright jmwright requested review from lorenzncode and jmwright May 31, 2022 23:46
Copy link
Member

@lorenzncode lorenzncode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @GandalfDG. I see this fixes many links in the CadQuery Concepts, Assemblies, and Examples sections.

Copy link
Member

@jmwright jmwright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @GandalfDG

@jmwright jmwright merged commit 9745762 into CadQuery:master Jun 1, 2022
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.

3 participants