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

Clean up CI & miscellaneous updates for 3.10 #911

Merged
merged 8 commits into from
Jan 22, 2025
Merged

Clean up CI & miscellaneous updates for 3.10 #911

merged 8 commits into from
Jan 22, 2025

Conversation

khaeru
Copy link
Member

@khaeru khaeru commented Jan 21, 2025

Parallel to iiasa/ixmp#555, plus:

How to review

  • View the revised docs, in particular:
    • Mention of the newsletter on the index page.
    • Organization of the index page and navigation pane.

PR checklist

  • Continuous integration checks all ✅
  • Add or expand tests; coverage checks both ✅
  • Add, expand, or update documentation.
    • Mention newsletter sign-up.
    • Correct outdated links embedded in GAMS code.
  • Update release notes.

@khaeru khaeru added enh New features & functionality docs Documentation ci Continuous integration labels Jan 21, 2025
@khaeru khaeru added this to the 3.10 milestone Jan 21, 2025
@khaeru khaeru self-assigned this Jan 21, 2025
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.6%. Comparing base (e0f2e02) to head (fe2086f).
Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##            main    #911      +/-   ##
========================================
+ Coverage   24.0%   95.6%   +71.6%     
========================================
  Files         48      48              
  Lines       4394    4394              
========================================
+ Hits        1057    4204    +3147     
+ Misses      3337     190    -3147     

see 45 files with indirect coverage changes

@khaeru
Copy link
Member Author

khaeru commented Jan 21, 2025

  • Mention newsletter sign-up.

@glatterf42 while working on this, I noticed that we have some toctree entries in the documentation that do not appear in the rendered docs:

message_ix/doc/index.rst

Lines 138 to 140 in e0f2e02

governance
sharing
security policy

This is because:

  • These files are in the top-level of the repo, outside the doc/ directory, and thus not visible to Sphinx without a relative path.
  • These are in Markdown, not ReST, and the file names are in lower case while the references are in upper case.

There is some good and useful text in these files, so I think they should be findable by people clicking around the documentation.

Based on your understanding of GitHub (or more general) practices, can you clarify:

  • Is it required that these files be where they are?
  • Is it required that the files be in Markdown format?

If yes to both, we can cope, but if no, then we I can very easily make sure they are integrated to the docs.

@glatterf42
Copy link
Member

Thanks, I read up in the docs:

  • Is it required that these files be where they are?

No, they can be in the root directory, .github/, or docs/. Unfortunately, though, I think this truly means docs/, i.e. our doc/ folder will likely not work.

  • Is it required that the files be in Markdown format?

Yes, I think so. In all examples and guides in GitHub's docs it is emphasized that the filename must be in all-caps and the ending .md.

While looking at the docs, I noticed that the community profile seems to not care about the GOVERNANCE.md file anymore. So I think it's entirely up to us what to do with that one.

- Drop old content:
  - Commented GAMS_VERSION.
  - Workaround for pyam-iamc exclusion of Python 3.13.
- Narrow workaround for ts-graphviz/setup-graphviz#630.
- Adjust 'tutorials' jobs parallel to #909, #910.
- Simplify installation of reticulate.
  - Drop use of "remotes"; call install.packages() directly.
- mypy v1.12.0 → v1.14.1.
  - Drop custom hook entry that uses PRE_COMMIT_MYPY_VENV.
  - Use config suggested at python/mypy#13916.
- ruff v0.8.4 → v0.9.1
- Copyedit some typos.
- Reflow text.
@khaeru
Copy link
Member Author

khaeru commented Jan 22, 2025

Thanks. For the moment I tried to ensure all the contents are linked from the docs index, and also added direct links to the CoC and discussions to the docs sidebar.

- Deduplicate text appearing in 3 input files.
- Use current URLs for documentation.
@khaeru khaeru requested a review from glatterf42 January 22, 2025 13:27
Copy link
Member

@glatterf42 glatterf42 left a comment

Choose a reason for hiding this comment

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

Thanks, looks good to me :)

@khaeru khaeru merged commit 663a744 into main Jan 22, 2025
27 checks passed
@khaeru khaeru deleted the enh/pre-3.10 branch January 22, 2025 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous integration docs Documentation enh New features & functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants