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

Generate package documentation #1

Merged
merged 14 commits into from
Feb 6, 2022
Merged

Generate package documentation #1

merged 14 commits into from
Feb 6, 2022

Conversation

lukasschwab
Copy link
Owner

@lukasschwab lukasschwab commented Feb 6, 2022 •
edited
Loading

Change

  • Add a docs directory with pdoc-generated documentation.
  • Copy docs generation, linter config, and Makefile from arxiv.
  • Breaking changes...
    • Renames _toOrderedDict to _to_ordered_dict across the board.
    • Replaces root parse with Feed.parse_string.
    • Restructures converters; requires from jsonfeed.converters import feedparser pattern.

Motivation

Make it easier to work with jsonfeed directly, e.g. for thoth-feeds.

To do

Follow-on tasks:

  • Configure GitHub Pages to host from a directory on master after merging.
  • Update dependents.
  • Tag a 1.0.0 release.

@lukasschwab
Push new TODOs
1b327dd
@lukasschwab
Add Make targets, config to match arxiv
4f9561d
@lukasschwab
Lint, remove __init__ files: should be unnecessary
19ec1ea
@lukasschwab
Fixup docs generation for new module structure
a264f35
@lukasschwab
Snake-case method names; bump version to 1.0.0
db25941
@lukasschwab
Add todo
2a5eff7
@lukasschwab
Add import interface tests
f86261b 
Definitely a bodge, but it covers my usage of jf/jfc.
@lukasschwab
Add __str__, __repr__ methods
f6c56f8 
__repr__ methods are just returning __str__(); thismight merit fixing in
the future.
@lukasschwab
Add GitHub workflows: check-docs, python-lint-test
305a7eb
@lukasschwab
Try adding __init__.py to fix CI test imports
b874fde
@lukasschwab
Re-add init.py to make imports work
9a2306f
@lukasschwab
Restructure package
bbcf70b 
+ Move jsonfeed from module into __init__.py. Ugly, but it gets the
  default import dynamics I want.
+ Put feedparser converter in converters package without __init__.py.
  Clients must use the `from jsonfeed.converters import feedparser`
  pattern.
+ Add feedparser dependency to requirements.txt.
@lukasschwab
Remove tests directory from docs
90b857e
This was referenced Feb 6, 2022
Open
Open
@lukasschwab lukasschwab marked this pull request as ready for review February 6, 2022 21:34
@lukasschwab lukasschwab merged commit 65acde7 into master Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
1.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@lukasschwab