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 source variable docs #85

Closed
jmbannon opened this issue Jul 2, 2022 · 2 comments
Closed

Clean up source variable docs #85

jmbannon opened this issue Jul 2, 2022 · 2 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@jmbannon
Copy link
Owner

jmbannon commented Jul 2, 2022

Source variables are information from the media downloaded from ytdlp that can be used to set file names or metadata. They are documented here:
https://ytdl-sub.readthedocs.io/en/latest/config.html#source-variables

If you notice, a few variables' formatting looks weird. Like this one:
https://ytdl-sub.readthedocs.io/en/latest/config.html#ytdl_sub.entries.variables.youtube_variables.YoutubeVideoVariables.artist

There are random asterisks, and it seems like the NOTE changes formatting in some way.

The documentation for these should get cleaned up. They are generated from the docstrings in here:
https://github.com/jmbannon/ytdl-sub/tree/master/src/ytdl_sub/entries/variables

The docs are created using reStructuredText (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) and the autodocs extension (https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html)

To build the docs locally, run make docs

@jmbannon jmbannon added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 2, 2022
@jmbannon jmbannon added this to the Release 0.2.0 milestone Jul 2, 2022
@glunkad
Copy link

glunkad commented Jul 3, 2022

Hey @jmbannon , I'm interested in contributing to this issue, so before I start working on it, would you mind sparing your time explaining what the issue is about and pointing me to some resources to get started .

@jmbannon
Copy link
Owner Author

jmbannon commented Jul 4, 2022

Hi @9gl , thanks for your interest! I added a better description and some code links. Let me know if you have any questions :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants