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

Update doc build instructions #342

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mcbarton
Copy link
Collaborator

@mcbarton mcbarton commented Oct 28, 2024

This the first in a series of PRs to update the documentation folder. This first PR will update the build instructions to match those in the readme.

@mcbarton
Copy link
Collaborator Author

@vgvassilev I ran 'rstfmt -w 80' on both files, so hopefully that fixes the width issue. Any other comments on the PR, or is it ok to merge now?

Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.43%. Comparing base (29588be) to head (a821d33).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #342   +/-   ##
=======================================
  Coverage   74.43%   74.43%           
=======================================
  Files           8        8           
  Lines        3204     3204           
=======================================
  Hits         2385     2385           
  Misses        819      819           

@vgvassilev
Copy link
Contributor

Looks good to me but do we have a CI to make sure our docs PRs work? If not we can steal the one we did in clad...

@mcbarton
Copy link
Collaborator Author

I'll copy the ci from Clad which checks docs to CppInterOp tomorrow, then you can review the PR again.

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