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

20240131 Update readthedocs generation #386

Closed
3 of 4 tasks
mkeilman opened this issue Aug 11, 2023 · 3 comments · Fixed by #488
Closed
3 of 4 tasks

20240131 Update readthedocs generation #386

mkeilman opened this issue Aug 11, 2023 · 3 comments · Fixed by #488

Comments

@mkeilman
Copy link
Contributor

mkeilman commented Aug 11, 2023

Precipitated by this notification. Investigate how they currently generate this documentation vs the new method and make changes accordingly.

See also #37

To clarify a bit, here's what readthedocs is expecting in the repo of interest:

  • .readthedocs.yml at the root level, minimally:
version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.9"
  jobs:
    pre_build:
     - <commands to run>

sphinx:
  configuration: docs/conf.py

python:
    install:
    - requirements: docs/requirements.txt
  • docs/conf.py
  • docs/requirements.txt

In the current state of PR #392, "commands to run" is python setup.py install --force (which readthedocs used to do automatically). That's done to run pksetup, which generates the conf.py above; accordingly, requirements.txt contains pykern. The purpose of #393 is to take pksetup out of the process and the purpose of radiasoft/download#526 is to make "commands to run" something like curl https://radia.run | bash -s readthedocs

@mkeilman mkeilman self-assigned this Aug 11, 2023
@mkeilman
Copy link
Contributor Author

Another relevant post

mkeilman pushed a commit that referenced this issue Aug 28, 2023
mkeilman pushed a commit that referenced this issue Aug 28, 2023
mkeilman pushed a commit that referenced this issue Aug 28, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Aug 29, 2023
mkeilman pushed a commit that referenced this issue Oct 5, 2023
mkeilman pushed a commit that referenced this issue Oct 5, 2023
@robnagler
Copy link
Member

@mkeilman how is this going?

@mkeilman
Copy link
Contributor Author

mkeilman commented Jan 4, 2024

@mkeilman how is this going?

Taken a back seat to other things, but I just got an email about adding secrets to webhooks. I don't know how that affects our projects, but in any case I'll give it my attention again. The email references a Jan. 31 deadline - that's a reasonable timeframe to complete this issue as well I think.

@mkeilman mkeilman changed the title Update readthedocs generation 20240131 Update readthedocs generation Jan 4, 2024
mkeilman pushed a commit that referenced this issue Jan 5, 2024
mkeilman pushed a commit that referenced this issue Jan 5, 2024
mkeilman pushed a commit that referenced this issue Jan 5, 2024
@robnagler robnagler assigned robnagler and unassigned mkeilman and robnagler Jun 2, 2024
robnagler added a commit that referenced this issue Jun 20, 2024
- pksetup: removed tox, readthedocs support
Fix #429 added readthedocs.yml
Fix #386 projex generates proper sphinx and readthedocs.yml
Fix #393 added pkcli.sphinx.prepare for readthedocs
- Added sphinx test which also tests projex
- Fixed various RST errors in modules
Fix #449 use GitHub workflow actions/checkout@v4 (also projex)
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 a pull request may close this issue.

2 participants