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.

Sign up for GitHub

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

Jump to bottom

Merge documentation changes into release branch #1468

Merged
merged 44 commits into from
May 22, 2023
Merged

Merge documentation changes into release branch #1468

merged 44 commits into from
May 22, 2023

Conversation

JimMadge
Copy link
Member

✅ Checklist

  • You have given your pull request a meaningful title (e.g. Enable foobar integration rather than 515 foobar).
  • You are targeting the develop branch.
  • Your branch is up-to-date with the develop branch (you probably started your branch from develop but it may have changed since then).
  • If-and-only-if your changes are not yet ready to merge, you have marked this pull request as a draft pull request and added '[WIP]' to the title.
  • If-and-only-if you have changed any Powershell code, you have run the code formatter. You can do this with ./tests/AutoFormat_Powershell.ps1 -TargetPath <path to file or directory>.

⤴️ Summary

  • Merge documentation changes (including read the docs migration) into the release v4.0.4 branch.

🌂 Related issues

🔬 Tests

edwardchalstrey1 and others added 30 commits February 28, 2023 10:43
@edwardchalstrey1
update VM size note
990f2cb
@edwardchalstrey1
update note
ad51af8
@edwardchalstrey1
changenote to tip and make bold
b8e1808
@edwardchalstrey1
remove word
76723b6
@JimMadge
Add readthedocs configuration
82d1f0d
@JimMadge
Move sphinx configuration and doc requirements
57e6f10
@JimMadge
Move static and template directories
077db5d
@JimMadge
Remove rinoh
1e4855e
@JimMadge
Remove build directory
b3f1aa2
@JimMadge
Remove pdf builds from Makefile
111389a
@JimMadge
Disable readthedocs pdf builds
cc86c41 
At least temporarily to safe time/cpu cycles.
@JimMadge
Move scriberia figure
12e6cf5
@JimMadge
Move docs source to source dir
c8369d9
@JimMadge
Clean Sphinx configuration
b08992d
@JimMadge
Update requirements
4ccb3f0
@JimMadge
Restore sidebar
b0b8334 
This seem to have broken after a theme update.
@JimMadge
Use default primary sidebar
5a6aad1 
This results in a very similar appearance with better readthedocs
integration.
@JimMadge
Remove unused import
772d89d
@JimMadge
Improve docs reproducibility with pip-compile
ca53abe
@JimMadge
Fix indentation
1394d7d
@JimMadge
Remove docs deployment workflow
e78560a
@JimMadge
Add documentation workflow
af93975 
This workflow has two jobs

- Build documentation
- Check links in built documentation

The lint html job has been removed from the lint code workflow.
html-proofer now only offer limited html linting and is mainly a link
checker.
@JimMadge
Add lychee configuration file
ee66f2f
@JimMadge @web-flow
Update PyPI and CRAN allow lists
be64393
@JimMadge
Merge pull request #1454 from alan-turing-institute/package-allowlist…
d215d82 
…-updates

Update PyPI and CRAN allow lists
@JimMadge
Add ipaddressguide.com to lychee exclude list
32f8943
@JimMadge
Exclude template file from link checking
f5e61fe
@JimMadge
Add lychee cache files to gitignore
9964d3b
@JimMadge
Add opensource.org to lychee exclude list
6db5cfb 
Returns 403 in CI.
@JimMadge
Remove unnecessary period
6558096
JimMadge and others added 14 commits May 7, 2023 00:16
@JimMadge @web-flow
Update PyPI and CRAN allow lists
c2c1d5e
@JimMadge
Merge pull request #1456 from alan-turing-institute/package-allowlist…
f2c669e 
…-updates

Update PyPI and CRAN allow lists
@JimMadge
Update CITATION.cff
c36f984
@JimMadge
Update documentation links in README
8b81d1a
@JimMadge
Update documentation link in contribution guide
75149a4
@JimMadge
Correct reference label
029b6ab
@JimMadge
Add data preparation advice
3ee1b84
@JimMadge
Fix linting errors
06f7d8d
@JimMadge @web-flow
Update SRD package versions
dbc4a48
@JimMadge
Merge pull request #1460 from alan-turing-institute/srd-package-versions
fdd0c00 
Update SRD package versions
@JimMadge
Remove unused javascript file
62a59c8
@JimMadge
Merge pull request #1408 from edwardchalstrey1/vm-docs-note
ebdac52 
Update VM resizing note to suggest stopping the VM before increasing the quota
@JimMadge
Merge pull request #1459 from alan-turing-institute/data_integrity
208e223 
Add data preparation guidance (including data integrity)
@JimMadge
Merge remote-tracking branch 'origin/develop' into readthedocs
20b8e1f
jemrobinson
jemrobinson approved these changes May 22, 2023
View reviewed changes
Copy link
Member

@jemrobinson jemrobinson left a comment

Choose a reason for hiding this comment

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

LGTM

@JimMadge JimMadge merged commit 90d1add into release-v4.0.4 May 22, 2023
@JimMadge JimMadge deleted the readthedocs branch May 22, 2023 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jemrobinson jemrobinson jemrobinson approved these changes

@martintoreilly martintoreilly Awaiting requested review from martintoreilly

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@JimMadge @jemrobinson @edwardchalstrey1