Skip to content

Commit 31f7654

Browse files
authored
Use pydata theme for docs (#163)
* Update requirements.txt * Update conf.py * moving things around
1 parent 32b29c8 commit 31f7654

File tree

16 files changed

+45
-69
lines changed

16 files changed

+45
-69
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ TUTORIALS = tutorials/hyper.rst tutorials/model.rst tutorials/new-kernel.rst \
1919
tutorials/first.rst tutorials/scaling.rst tutorials/mixture.rst \
2020
tutorials/bayesopt.rst
2121

22-
tutorials/%.rst: _static/notebooks/%.ipynb tutorials/tutorial_rst.tpl
22+
tutorials/%.rst: _static/notebooks/%.ipynb
2323
jupyter nbconvert --template tutorials/tutorial_rst --to rst $< --output-dir tutorials
2424

2525
.PHONY: clean

docs/conf.py

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
master_doc = "index"
4545

4646
# General information about the project.
47-
project = u"George"
48-
copyright = u"2012-2021 Dan Foreman-Mackey"
47+
project = "george"
48+
copyright = "2012-2023 Dan Foreman-Mackey"
4949

5050
version = george.__version__
5151
release = george.__version__
@@ -54,22 +54,17 @@
5454
pygments_style = "sphinx"
5555

5656
# Readthedocs.
57-
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
58-
if not on_rtd:
59-
import sphinx_rtd_theme
60-
61-
html_theme = "sphinx_rtd_theme"
62-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
63-
57+
html_theme = "pydata_sphinx_theme"
58+
html_title = "george"
6459
htmp_theme_options = dict(
6560
analytics_id="analytics_id",
6661
)
67-
html_context = dict(
68-
display_github=True,
69-
github_user="dfm",
70-
github_repo="george",
71-
github_version="main",
72-
conf_py_path="/docs/",
73-
)
62+
# html_context = dict(
63+
# display_github=True,
64+
# github_user="dfm",
65+
# github_repo="george",
66+
# github_version="main",
67+
# conf_py_path="/docs/",
68+
# )
7469
html_static_path = ["_static"]
75-
html_show_sourcelink = False
70+
# html_show_sourcelink = False

docs/index.rst

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,26 +30,9 @@ George is being actively developed in `a public repository on GitHub
3030

3131
.. toctree::
3232
:maxdepth: 2
33-
:caption: User Guide
3433

35-
user/quickstart
36-
user/kernels
37-
user/gp
38-
user/solvers
39-
user/modeling
40-
41-
42-
.. toctree::
43-
:maxdepth: 1
44-
:caption: Tutorials
45-
46-
tutorials/first
47-
tutorials/model
48-
tutorials/hyper
49-
tutorials/scaling
50-
tutorials/new-kernel
51-
tutorials/mixture
52-
tutorials/bayesopt
34+
user/index
35+
tutorials/index
5336

5437

5538
Contributors
@@ -61,9 +44,9 @@ Contributors
6144
License & Attribution
6245
---------------------
6346

64-
Copyright 2012-2022 Daniel Foreman-Mackey and contributors.
47+
Copyright 2012-2023 Daniel Foreman-Mackey and contributors.
6548

66-
George is being developed by `Dan Foreman-Mackey <http://dan.iel.fm>`_ in a
49+
George is being developed by `Dan Foreman-Mackey <https://dfm.io>`_ in a
6750
`public GitHub repository <https://github.com/dfm/george>`_.
6851
The source code is made available under the terms of the MIT license.
6952

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
pyyaml
2+
pydata-sphinx-theme

docs/tutorials/bayesopt.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
.. module:: george
3-
41
.. note:: This tutorial was generated from an IPython notebook that can be
52
downloaded `here <../../_static/notebooks/bayesopt.ipynb>`_.
63

docs/tutorials/first.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
.. module:: george
3-
41
.. note:: This tutorial was generated from an IPython notebook that can be
52
downloaded `here <../../_static/notebooks/first.ipynb>`_.
63

docs/tutorials/hyper.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
.. module:: george
3-
41
.. note:: This tutorial was generated from an IPython notebook that can be
52
downloaded `here <../../_static/notebooks/hyper.ipynb>`_.
63

docs/tutorials/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Tutorials
2+
=========
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
first
8+
model
9+
hyper
10+
scaling
11+
new-kernel
12+
mixture
13+
bayesopt
14+

docs/tutorials/mixture.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
.. module:: george
3-
41
.. note:: This tutorial was generated from an IPython notebook that can be
52
downloaded `here <../../_static/notebooks/mixture.ipynb>`_.
63

docs/tutorials/model.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
.. module:: george
3-
41
.. note:: This tutorial was generated from an IPython notebook that can be
52
downloaded `here <../../_static/notebooks/model.ipynb>`_.
63

0 commit comments

Comments
 (0)