Skip to content

Conversation

@teutoburg
Copy link
Contributor

@teutoburg teutoburg commented Jun 27, 2025

RTD build just fine without them. Nobody builds the docs locally anyway AFAIK. So this is just deadweight.

@teutoburg teutoburg self-assigned this Jun 27, 2025
@teutoburg teutoburg added the documentation Improvements or additions to documentation label Jun 27, 2025
@teutoburg teutoburg moved this from 🆕 New to 🏗 In progress in ScopeSim-development Jun 27, 2025
@codecov
Copy link

codecov bot commented Jun 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.74%. Comparing base (f46ddae) to head (ed00ade).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #709   +/-   ##
=======================================
  Coverage   76.74%   76.74%           
=======================================
  Files          73       73           
  Lines        8791     8791           
=======================================
  Hits         6747     6747           
  Misses       2044     2044           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@teutoburg teutoburg marked this pull request as ready for review June 27, 2025 13:49
@teutoburg teutoburg requested a review from a team June 27, 2025 13:49
@teutoburg teutoburg moved this from 🏗 In progress to 👀 Awaiting Review in ScopeSim-development Jun 27, 2025
Copy link
Collaborator

@hugobuddel hugobuddel left a comment

Choose a reason for hiding this comment

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

It is good to be able to build the docs locally. E.g. wouldn't that have helped with debugging #689 ?

And we were planning to build the documentation (including notebooks, and inline-code) on zeus and then uploading to RTD, so we don't have to store the notebooks with output. So maybe keep the makefile?

@teutoburg
Copy link
Contributor Author

And we were planning to build the documentation (including notebooks, and inline-code) on zeus and then uploading to RTD, so we don't have to store the notebooks with output.

I think that only really applies to the IRDB for now, because building the ScopeSim docs themselves doesn't require too many resources, so building (incl. all notebooks) entirely on RTD is fine.

It is good to be able to build the docs locally.

Yeah, I guess it wouldn't hurt to keep that ability. I'm re-drafting this for now and come back once I understand how local Sphinx builds actually work (never done that, always relied on RTD).

@teutoburg teutoburg marked this pull request as draft June 27, 2025 15:02
@teutoburg teutoburg moved this from 👀 Awaiting Review to 🚧 On hold in ScopeSim-development Jul 20, 2025
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

Status: 🚧 On hold

Development

Successfully merging this pull request may close these issues.

3 participants