Skip to content

Latest commit

 

History

History
156 lines (109 loc) · 4.83 KB

README.md

File metadata and controls

156 lines (109 loc) · 4.83 KB
Raw

PyTorch Sphinx Theme

Sphinx theme for PyTorch Docs and PyTorch Tutorials based on the Read the Docs Sphinx Theme.

Local Development

Install PyTorch Sphinx Theme:

git clone https://github.com/pytorch/pytorch_sphinx_theme
pip install -r docs/requirements.txt
pip install -e .

In the root directory, install the dependencies using either yarn using yarn install OR npm using npm install (not both):

Create an empty .env.json file in the root directory and build the site with live reloading

echo '{}' > .env.json
grunt build

If you want to specify the project folder (docs or tutorial for which you want to see docs generated) then you need to specify it into .env.json file:

{
    "DOCS_DIR": "docs/",
    "TUTORIALS_DIR": "path/to/tutorial/directory"
}

Testing your changes and submitting a PR

When you are ready to submit a PR with your changes you can first test that your changes have been applied correctly against either the PyTorch Docs or Tutorials repo:

  1. Run the grunt build task on your branch and commit the build to Github.
  2. In your local docs or tutorials repo, remove any existing pytorch_sphinx_theme packages in the src folder (there should be a pip-delete-this-directory.txt file there)
  3. Clone the repo locally git clone https://github.com/pytorch/pytorch_sphinx_theme
  4. Install pytorch_sphinx_theme by running pip install -e pytorch_sphinx_theme
  5. Install the requirements pip install -r requirements.txt
  6. Remove the current build. In the docs this is make clean, tutorials is make clean-cache
  7. Build the static site. In the docs this is make html, tutorials is make html-noplot
  8. Open the site and look around. In the docs open docs/build/html/index.html, in the tutorials open _build/html.index.html

If your changes have been applied successfully, remove the build commit from your branch and submit your PR.

Publishing the theme

Before the new changes are visible in the theme the maintainer will need to run the build process:

grunt build

Once that is successful commit the change to Github.

Developing locally against PyTorch Docs and Tutorials

To be able to modify and preview the theme locally against the PyTorch Docs and/or the PyTorch Tutorials first clone the repositories:

git clone https://github.com/pytorch/pytorch
git clone https://github.com/pytorch/tutorials

Then follow the instructions in each repository to make the docs.

Once the docs have been successfully generated you should be able to run the following to create an html build.

pytorch/pytorch/docs

cd pytorch/docs
make html

Tutorials

cd tutorials
make html

Once these are successful, navigate to the conf.py file in each project. In the Docs these are at ./docs/source. The Tutorials one can be found in the root directory.

In conf.py change the html theme to pytorch_sphinx_theme and point the html theme path to this repo's local folder, which will end up looking something like:

html_theme = 'pytorch_sphinx_theme'
html_theme_path = ["../../../pytorch_sphinx_theme"]

Next create a file .env.json in the root of this repo with some keys/values referencing the local folders of the Docs and Tutorials repos:

{
  "TUTORIALS_DIR": "../tutorials",
  "DOCS_DIR": "../pytorch/docs/source"
}

You can then build the Docs or Tutorials by running

grunt --project=docs

or

grunt --project=tutorials

These will generate a live-reloaded local build for the respective projects available at localhost:1919.

Note that while live reloading works these two projects are hefty and will take a few seconds to build and reload, especially the Docs.

Built-in Stylesheets and Fonts

There are a couple of stylesheets and fonts inside the Docs and Tutorials repos themselves meant to override the existing theme. To ensure the most accurate styles we should comment out those files until the maintainers of those repos remove them:

pytorch/pytorch/docs

# ./docs/source/conf.py

html_context = {
    # 'css_files': [
    #     'https://fonts.googleapis.com/css?family=Lato',
    #     '_static/css/pytorch_theme.css'
    # ],
}

pytorch/tutorials

# ./conf.py

# app.add_stylesheet('css/pytorch_theme.css')
# app.add_stylesheet('https://fonts.googleapis.com/css?family=Lato')

Top/Mobile Navigation

The top navigation and mobile menu expect an "active" state for one of the menu items. To ensure that either "Docs" or "Tutorials" is marked as active, set the following config value in the respective conf.py, where {project} is either "docs" or "tutorials".

html_theme_options = {
  ...
  'pytorch_project': {project}
  ...
}