Remove archived documentation from repo, point to new location

NCAS-CMS / cfdm

A Python reference implementation of the CF data model

http://ncas-cms.github.io/cfdm

MIT License

28 stars 11 forks source link

Remove archived documentation from repo, point to new location #265

Closed sadielbartholomew closed 1 year ago

sadielbartholomew commented 1 year ago

Removes the built archived documentation (essentially that contained in the docs/1.* directories) which has moved to its new home in the NCAS-CMS/cfdm-docs repository and updates the links to such archived docs so that the latest documentation points to the new location.

Note for reviewing the following:

This PR is equivalent to NCAS-CMS/cf-python#663 for cf-python.
The initial link to the 'Version 1.10.1.0' archived docs will not work because that latest set of docs pages was not generated to the main 'cfdm' repo in order to be moved over to 'cfdm-docs', but all other links should work. We should work out how to add v1.10.1.0 retrospectively to the cfdm-docs repo after this is merged.

codecov[bot] commented 1 year ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (main@7d06b0c). Click here to learn what that means. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #265   +/-   ##
=======================================
  Coverage        ?   87.36%           
=======================================
  Files           ?      125           
  Lines           ?    12887           
  Branches        ?        0           
=======================================
  Hits            ?    11258           
  Misses          ?     1629           
  Partials        ?        0

Flag	Coverage Δ
unittests	`87.36% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

sadielbartholomew commented 1 year ago

Thanks for the review, David.

I haven't really checked all 5000+ file changes, but I'm sure it's fine :)

Not expected of course (that would be intense! :slightly_smiling_face: ), but FYI in case it wasn't clear it's all removal of the archived built documentation, hence the referenced -~10 million line count, bar the final two commits which only apply cfdm -> cfdm-docs in the archived documentation links (both source .rst and built .html) to explain the '+65' in the count.

Merging now.