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

Tweaks to documentation #56

Merged
merged 11 commits into from
Oct 18, 2024
Merged

Tweaks to documentation #56

merged 11 commits into from
Oct 18, 2024

Conversation

ffl096
Copy link
Member

@ffl096 ffl096 commented Oct 16, 2024

  • Adds a link to the GitHub repository to the right of the documentation navbar.
  • Replaces the doc source button with a more helpful edit button.
  • Add "copy code" button to all examples.
  • Add a standard code of conduct.

Depends on pyt-team/TopoNetX#392 (for the code of conduct).

@ffl096 ffl096 added the documentation Improvements or additions to documentation label Oct 16, 2024
@ffl096 ffl096 self-assigned this Oct 16, 2024
@ffl096 ffl096 changed the title Add GitHub link to doc header Tweaks to documentation Oct 16, 2024
Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.62%. Comparing base (95c4abf) to head (8c83d04).
Report is 16 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #56   +/-   ##
=======================================
  Coverage   96.62%   96.62%           
=======================================
  Files           8        8           
  Lines         178      178           
=======================================
  Hits          172      172           
  Misses          6        6           

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

@ffl096 ffl096 merged commit 122b56f into main Oct 18, 2024
10 checks passed
@ffl096 ffl096 deleted the frantzen/docs-github-link branch October 18, 2024 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant