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

docs: native build, update sphinx, add versioning #1679

Merged
merged 7 commits into from
Feb 9, 2024
Merged

Conversation

casperdcl
Copy link
Member

@casperdcl casperdcl commented Feb 7, 2024

Describe your changes

Notes

github ref destination
master https://tomographicimaging.github.io/CIL/nightly
vM.m.p https://tomographicimaging.github.io/CIL/vM.m.p
#123 DocumentationHTML:/123_merge
  • https://tomographicimaging.github.io/CIL/ redirects to https://tomographicimaging.github.io/CIL/nightly

follow-up (not that trivial to do):

github ref destination
latest vM.m.p https://tomographicimaging.github.io/CIL/stable
  • https://tomographicimaging.github.io/CIL/ redirects to https://tomographicimaging.github.io/CIL/stable

Describe any testing you have performed

  • Download & unzip the DocumentationHTML art[ie]fact from the GitHub Actions run
  • run python -m http.server

Link relevant issues

Checklist when you are ready to request a review

  • I have performed a self-review of my code
  • I have added docstrings in line with the guidance in the developer guide
  • I have implemented unit tests that cover any new or modified functionality
  • CHANGELOG.md has been updated with any functionality change
  • Request review from all relevant developers
  • Change pull request label to 'Waiting for review'

Contribution Notes

Please read and adhere to the developer guide and local patterns and conventions.

  • The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CIL (the Work) under the terms and conditions of the Apache-2.0 License.
  • I confirm that the contribution does not violate any intellectual property rights of third parties

@casperdcl casperdcl self-assigned this Feb 7, 2024
@casperdcl casperdcl changed the title add .gitignore sphinx docs builds Feb 7, 2024
@casperdcl casperdcl changed the title sphinx docs builds docs: native sphinx build Feb 7, 2024
@casperdcl casperdcl force-pushed the bump-sphinx branch 3 times, most recently from 28ed5d5 to 0735bbc Compare February 7, 2024 16:13
@casperdcl casperdcl mentioned this pull request Feb 8, 2024
8 tasks
@casperdcl casperdcl force-pushed the bump-sphinx branch 3 times, most recently from 4a3ed53 to 079c4b6 Compare February 8, 2024 14:28
@lauramurgatroyd
Copy link
Member

I tested the new docs_environment.yml locally and it worked well!

@casperdcl casperdcl marked this pull request as ready for review February 8, 2024 15:03
@casperdcl casperdcl changed the title docs: native sphinx build docs: native build, update sphinx, add versioning Feb 8, 2024
@casperdcl casperdcl mentioned this pull request Feb 8, 2024
16 tasks
@casperdcl casperdcl merged commit 928c2dd into master Feb 9, 2024
3 checks passed
@casperdcl casperdcl deleted the bump-sphinx branch February 9, 2024 13:39
@casperdcl casperdcl mentioned this pull request Feb 9, 2024
21 tasks
casperdcl added a commit that referenced this pull request Mar 12, 2024
* fix import warning (from #1736)
* docs: fix missing GPU packages (from #1679, fixes #1746)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Archived in project
3 participants