Skip to content

infra: upgrade Sphinx to 3.1.1 #1605

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

Merged
merged 3 commits into from
Jun 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,23 +164,26 @@ You can also run them in parallel:
Building Sphinx docs
~~~~~~~~~~~~~~~~~~~~

Setup a Python environment with ``sphinx`` and ``sagemaker``:
Setup a Python environment, and install the dependencies listed in ``doc/requirements.txt``:

::

# conda
conda create -n sagemaker python=3.7
conda activate sagemaker
conda install sphinx==2.2.2
pip install sagemaker --user
conda install --file doc/requirements.txt

Install the Read The Docs theme:
# pip
pip install -r doc/requirements.txt

::

pip install sphinx_rtd_theme --user
Clone/fork the repo, and install your local version:

::

pip install --upgrade .

Clone/fork the repo, ``cd`` into the ``sagemaker-python-sdk/doc`` directory and run:
Then ``cd`` into the ``sagemaker-python-sdk/doc`` directory and run:

::

Expand Down
6 changes: 2 additions & 4 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
sphinx==2.2.2
numpy
scipy
requests==2.20
sphinx==3.1.1
sphinx-rtd-theme==0.5.0
14 changes: 0 additions & 14 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -98,20 +98,6 @@ commands =
[testenv:sphinx]
basepython = python3
changedir = doc
# Based on: https://github.com/rtfd/readthedocs.org/blob/8f0c78dde5edcc85acf90462a8518735a25482d3/readthedocs/doc_builder/python_environments.py#L263
install_command = python -m pip install --upgrade -I {packages}
# Based on: https://github.com/rtfd/readthedocs.org/blob/8f0c78dde5edcc85acf90462a8518735a25482d3/readthedocs/doc_builder/python_environments.py#L280
deps =
Pygments==2.2.0
setuptools<40
docutils==0.13.1
mock==1.0.1
alabaster>=0.7,<0.8,!=0.7.5
commonmark==0.5.4
recommonmark==0.4.0
sphinx<1.8
sphinx-rtd-theme<0.5
readthedocs-sphinx-ext<0.6
# pip install requirements.txt is separate as RTD does it in separate steps
# having the requirements.txt installed in deps above results in Double Requirement exception
# https://github.com/pypa/pip/issues/988
Expand Down