Skip to content

Conversation

vincentqb
Copy link
Contributor

- Addresses pytorch#549 pytorch#638 pytorch#786
- Add `torchaudio` top level module doc
- Separate `torchaudio` top level module doc from `index.html`
- Add `backend` module doc.
- Remove `-> None` from function signature as it adds noise to documentation
- Changed function argument name of `torchaudio.backend.sox_io_backend.save` from `tensor` to `src`, so that it matches with the reset of backends.
- Tweak bunch of docstrings
@vincentqb vincentqb requested a review from mthrok July 28, 2020 15:41
Copy link
Contributor

@mthrok mthrok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@vincentqb vincentqb merged commit c3e673a into pytorch:release/0.6 Jul 28, 2020
@vincentqb
Copy link
Contributor Author

For reference, how to build docs for website:

conda create -n torchaudiodocs
conda activate torchaudiodocs

conda install sphinx-build
conda install sphinx
conda install -c pytorch pytorch
pip install sphinxcontrib-katex

# Install latest pytorch_sphinx_theme in conda environment

# Get a fresh copy of torchaudio
git clone https://github.com/pytorch/audio audio-docs
git checkout origin/release/0.6
cd audio-docs/docs
make html
git checkout origin/gh-pages
cd ..
cp -rp docs/build/html/* ./
git add .
git commit -m"update docs for 0.6.0"
git push origin gh-pages

@vincentqb vincentqb mentioned this pull request Jul 28, 2020
6 tasks
@mthrok mthrok mentioned this pull request Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants