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

documentation fixing headers and index #233

Merged
merged 3 commits into from
Dec 10, 2024

Conversation

RyanGroneck
Copy link
Contributor

📝 Description

Type: 📝 documentation

This pr does 3 main things:

  1. Should fix headings in each documentation notebook (resolving the issue with the model return type doc), making things look nicer.

  2. reformat index so that documentation on the website appears in its own separate section

  3. change the rotation broadening documentation's name/title to reflect what it is

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@jvshields jvshields marked this pull request as draft December 3, 2024 18:57
@jvshields jvshields added documentation Improvements or additions to documentation build_docs labels Dec 4, 2024
@jvshields jvshields marked this pull request as ready for review December 4, 2024 19:41
@jvshields jvshields added the benchmarks Trigger benchmarks to run on this pr label Dec 4, 2024
@tardis-bot
Copy link
Contributor

tardis-bot commented Dec 4, 2024

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing main (7bddf42) and the latest commit (12a3042).
Here are the logs produced by ASV.
Results can also be downloaded as artifacts here.
Significantly changed benchmarks:

· Benchmark list file .asv/results/benchmarks.json missing!
Use `asv run --bench just-discover` to regenerate benchmarks.json

All benchmarks:

· Benchmark list file .asv/results/benchmarks.json missing!
Use `asv run --bench just-discover` to regenerate benchmarks.json

@RyanGroneck
Copy link
Contributor Author

I built the website/documentation locally and everything appeared to display as intended.

@jvshields jvshields merged commit e3a49fe into tardis-sn:main Dec 10, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
benchmarks Trigger benchmarks to run on this pr build_docs documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants