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

Documentation cleanup #538

Merged
merged 32 commits into from
Jan 26, 2024
Merged

Documentation cleanup #538

merged 32 commits into from
Jan 26, 2024

Conversation

sjpfenninger
Copy link
Member

@sjpfenninger sjpfenninger commented Jan 10, 2024

Summary of changes in this pull request:

  • Moves over some of the most important docs pages from rst to md
  • Removes all parts of the old documentation which have already been converted or are no longer needed, to make it easier to track what remains to go through

STILL TODO:

  • building.md needs to be rewritten - formally it's now markdown, and I've made some initial changes to improve the structure and content, but especially in the latter parts it still refers to no longer existing functionality
  • All newly-added docs need to be checked again for consistency with 0.7

Reviewer checklist:

  • Test(s) added to cover contribution
  • Documentation updated
  • Changelog updated
  • Coverage maintained or improved

@sjpfenninger sjpfenninger changed the title Feature docs cleanup Documentation cleanup Jan 12, 2024
Copy link

codecov bot commented Jan 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e2bfb1a) 95.66% compared to head (f19b1d9) 95.70%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #538      +/-   ##
==========================================
+ Coverage   95.66%   95.70%   +0.04%     
==========================================
  Files          24       24              
  Lines        3526     3562      +36     
  Branches      765      710      -55     
==========================================
+ Hits         3373     3409      +36     
  Misses         87       87              
  Partials       66       66              
Files Coverage Δ
src/calliope/backend/backend_model.py 97.84% <100.00%> (+0.10%) ⬆️
src/calliope/backend/pyomo_backend_model.py 94.94% <100.00%> (+0.35%) ⬆️
src/calliope/cli.py 81.67% <100.00%> (ø)
src/calliope/examples.py 100.00% <100.00%> (ø)
src/calliope/model.py 93.65% <ø> (ø)
src/calliope/preprocess/model_data.py 100.00% <ø> (ø)
src/calliope/util/logging.py 93.87% <ø> (ø)

@brynpickering
Copy link
Member

brynpickering commented Jan 22, 2024

I expect the markdown link check to fail because there's a hyperlink to a page in the docs from CONTRIBUTING.md that will only exist once this is merged in and v0.7.0 is released.

EDIT: updated to not point to a specific page int he docs. This seems a better approach for longer-term maintenance.

@sjpfenninger sjpfenninger merged commit c6a0e6a into main Jan 26, 2024
8 of 9 checks passed
@sjpfenninger sjpfenninger deleted the feature-docs-cleanup branch January 26, 2024 08:39
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 this pull request may close these issues.

2 participants