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

Doc cleanup #2983

Merged
merged 15 commits into from
Apr 22, 2024
Merged

Doc cleanup #2983

merged 15 commits into from
Apr 22, 2024

Conversation

flying-sheep
Copy link
Member

@flying-sheep flying-sheep commented Apr 8, 2024

This adds the missing bibtex formatter from my review in #2901. Since this PR is necessary to productively work with the bibliography without making a mess, and y’all are on a hackathon, I’ll merge it without review.

Content

  • Replace frail line based inclusions like :end-line: 32 with markers. If someone destroys a marker, the doc build will fail instead of containing a garbled mess.

  • Moves the flit-centric dev docs to non-opinionated tooling

  • Since there are no functional bib formatters that run within pre-commit (See Extend Sect. Related Programs by 'betterbib', 'python-bibtexparser', 'BibDesk' and 'ebib' ge-ne/bibtool#58), we’re going to have to live with using our own. For that purpose, I took the last open source version of betterbib and trimmed it down a bit

    Once there’s something better that we don’t have to maintain, we should use that

Companion PR: scverse/scanpy-tutorials#103

@flying-sheep flying-sheep changed the title Doc-cleanup Doc cleanup Apr 8, 2024
Copy link

codecov bot commented Apr 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.19%. Comparing base (0370057) to head (992245b).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2983      +/-   ##
==========================================
- Coverage   75.53%   73.19%   -2.35%     
==========================================
  Files         117      117              
  Lines       12950    12914      -36     
==========================================
- Hits         9782     9452     -330     
- Misses       3168     3462     +294     

see 29 files with indirect coverage changes

@flying-sheep flying-sheep added this to the 1.10.2 milestone Apr 22, 2024
@flying-sheep flying-sheep marked this pull request as ready for review April 22, 2024 10:59
@flying-sheep flying-sheep enabled auto-merge (squash) April 22, 2024 13:43
@flying-sheep flying-sheep self-assigned this Apr 22, 2024
@flying-sheep flying-sheep merged commit dbea062 into main Apr 22, 2024
16 checks passed
@flying-sheep flying-sheep deleted the doc-cleanup branch April 22, 2024 14:04
meeseeksmachine pushed a commit to meeseeksmachine/scanpy that referenced this pull request Apr 22, 2024
flying-sheep added a commit that referenced this pull request Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant