Skip to content

edwardtheharris/sphinxcontrib.youtube

 
 

Repository files navigation

abstract authors
This package allows inserting YouTube videos into Sphinx documents.
xander.harris@databricks.com

Sphinx-Contrib YouTube

This package was forked from
[this fork](https://github.com/divi255/sphinxcontrib.youtube/)
of the [original](https://github.com/shomah4a/sphinxcontrib.youtube).

Usage

Mostly because I don't feel like making a new package on PyPi, the installation for this is a little funky. You've got a couple of choices, first is to clone this repository then install it into your virtual environment[^pipenv], as an editable package like this.

  1. Clone the repository.

    src_dir="~/Documents/src/github.com/edwardtheharris/sphinxcontrib.youtube"
    git clone https://github.com/edwardtheharris/sphinxcontrib.youtube "$src_dir"
    
  2. Update your working directory.

    cd "$src_dir"
    
  3. Create your virtual environment.

    python3.10 -m pip install -U pip pipenv
    python3.10 -m pipenv --python 3.10 run
    
  4. Install the project in that environment.

pip3 install sphinxcontrib.yt
contributing
license
security

About

sphinx extrension to embed youtube video

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 47.4%
  • Makefile 23.4%
  • Batchfile 21.4%
  • Jupyter Notebook 7.5%
  • Shell 0.3%