Clean up source variable docs #85
Labels
bug
Something isn't working
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
Milestone
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
The text was updated successfully, but these errors were encountered: