Skip to content

Commit

Permalink
Fix docs build and switch to PyData Sphinx Theme (#1912)
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 authored Nov 25, 2022
1 parent 11ed7ab commit 83add7b
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ build:
image: latest

python:
version: 3.7
version: 3.8
install:
- method: pip
path: .
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@

### Jupyter Notebook Conversion

[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)
[![Build Status](https://travis-ci.org/jupyter/nbconvert.svg?branch=main)](https://travis-ci.org/jupyter/nbconvert)
[![Documentation Status](https://readthedocs.org/projects/nbconvert/badge/?version=latest)](https://nbconvert.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/nbconvert/badge/?version=stable)](https://nbconvert.readthedocs.io/en/stable/?badge=stable)
[![codecov.io](https://codecov.io/github/jupyter/nbconvert/coverage.svg?branch=main)](https://codecov.io/github/jupyter/nbconvert?branch=main)

The **nbconvert** tool, `jupyter nbconvert`, converts notebooks to various other
Expand Down
10 changes: 1 addition & 9 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,15 +135,7 @@

# -- Options for HTML output ----------------------------------------------

# Set on_rtd to whether we are building on readthedocs.org. We get this line of
# code grabbed from docs.readthedocs.org
on_rtd = os.environ.get("READTHEDOCS", None) == "True"

if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = "pydata_sphinx_theme"

# otherwise, readthedocs.org uses their default theme, so no need to specify it

Expand Down
2 changes: 1 addition & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ packages are specific to different operating systems:
sudo apt-get install texlive-xetex texlive-fonts-recommended texlive-plain-generic

* macOS (OS X): `MacTeX <http://tug.org/mactex/>`_.
* Windows: `MikTex <https://miktex.org/>`_
* Windows: `Latex Project <https://www.latex-project.org/get/>`_.

Because nbconvert depends on packages and fonts included in standard
TeX distributions, if you do not have a complete installation, you
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,10 @@ serve = ["tornado>=6.1"]
docs = [
"myst_parser",
"sphinx==5.0.2",
"sphinx_rtd_theme",
"pydata_sphinx_theme",
"nbsphinx>=0.2.12",
"ipython",
"ipykernel"
]
all = ["nbconvert[qtpdf,webpdf,test,serve,docs]"]

Expand Down

0 comments on commit 83add7b

Please sign in to comment.