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

Fix docs (CLI rewrite), fix rtd build, state AcousticBrainz shutdown in README #20

Merged
merged 3 commits into from
Jul 23, 2024
Merged

Fix docs (CLI rewrite), fix rtd build, state AcousticBrainz shutdown in README #20

merged 3 commits into from
Jul 23, 2024

Conversation

JOJ0
Copy link
Owner

@JOJ0 JOJ0 commented Jul 23, 2024 •
edited
Loading

  • Back in 2023 the CLI was rewritten:
    • dsc is based on Click
    • disco is based on argparser, which sometimes is a PITA
    • For now disco is still available but unmaintained.
    • This PR tries to fix docs to state dsc
    • Why not remove disco and rename dsc back to disco? Once upon a time some Debian folks showed up and complained about a name clash with a disco command from another package on Ubuntu. See naming conflict with mono-devel in '/usr/bin/disco' #15
    • Anyway, dsc is shorter anway....anyway...anyway...
  • AcousticBrainz was announced to be shutdown back in Feb 2022 and around 2023 being shutdown entirely (so they said), in any case, this PR states this unfortunate fact in the README, but for now does not bother to really fix the docs as a whole - this is a lot of work and postponed....
  • Finally the broken readthedocs build has been fixed with a .readthedocs.yaml

@JOJ0
Replace disco with dsc (wholeword) in docs
981ebdf 
using vscode search/replace.
@JOJ0 JOJ0 marked this pull request as ready for review July 23, 2024 10:05
JOJ0 added 2 commits July 23, 2024 15:04
@JOJ0
Add .readthedocs.yaml and fix year in sphinx conf.py
a4708eb
@JOJ0
Note AcousticBrainz shutdown in README
c405301 
but don't bother to remove all instances from Sphinx docs for now ->
A quickfix!
@JOJ0 JOJ0 changed the title Replace disco with dsc in docs Replace disco with dsc in docs, fix readthedocs build & not AcousticBrainz shutdown Jul 23, 2024
@JOJ0 JOJ0 changed the title Replace disco with dsc in docs, fix readthedocs build & not AcousticBrainz shutdown Fix docs (CLI rewrite)CLI in docs, fix rtd build, state AcousticBrainz shutdown in README Jul 23, 2024
@JOJ0 JOJ0 changed the title Fix docs (CLI rewrite)CLI in docs, fix rtd build, state AcousticBrainz shutdown in README Fix docs (CLI rewrite), fix rtd build, state AcousticBrainz shutdown in README Jul 23, 2024
@JOJ0 JOJ0 mentioned this pull request Jul 23, 2024
Open
@JOJ0 JOJ0 merged commit 0a76694 into master Jul 23, 2024
44 checks passed
JOJ0 added a commit that referenced this pull request Oct 29, 2024
@JOJ0
Merge pull request #20 from JOJ0/cmd23-docs
78eaf88 
Fix docs (CLI rewrite), fix rtd build, state AcousticBrainz shutdown in README
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
None yet
Projects
None yet
Milestone
No milestone
Development

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