Skip to content

Commit ddf4a54

Browse files
Remove docs from README, update docs
1 parent 870799f commit ddf4a54

File tree

4 files changed

+4
-15
lines changed

4 files changed

+4
-15
lines changed

.readthedocs.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
version: 2
22

33
build:
4-
os: ubuntu-20.04
4+
os: ubuntu-22.04
55
tools:
6-
python: "3.9"
6+
python: "3.12"
77

88
sphinx:
99
configuration: docs/conf.py

README.md

-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,15 @@
1-
[![Documentation](https://readthedocs.org/projects/pippin/badge/?version=latest)](https://pippin.readthedocs.io/en/latest/?badge=latest)
21
[![JOSS](https://joss.theoj.org/papers/10.21105/joss.02122/status.svg)](https://doi.org/10.21105/joss.02122)
32
[![Zenodo](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.366608-blue)](https://zenodo.org/badge/latestdoi/162215291)
43
[![GitHub license](https://img.shields.io/badge/License-MIT-green)](https://github.com/dessn/Pippin/blob/master/LICENSE)
54
[![Github Issues](https://img.shields.io/github/issues/dessn/Pippin)](https://github.com/dessn/Pippin/issues)
65
![Python Version](https://img.shields.io/badge/Python-3.7%2B-red)
76
![Pippin Test](https://github.com/dessn/Pippin/actions/workflows/test-pippin.yml/badge.svg)
87

9-
10-
118
# Pippin
129

13-
1410
Pippin - a pipeline designed to streamline and remove as much hassle as we can
1511
when running end-to-end supernova cosmology analyses.
1612

17-
The (work in progress) docs can be found [here](https://pippin.readthedocs.io/en/latest/index.html).
18-
19-
2013
## Table of Contents
2114

2215
<img align="right" height="350" src="docs/_static/images/meme.jpg">

docs/conf.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@
3030
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3131
# ones.
3232
extensions = [
33-
'sphinx_rtd_theme',
34-
'sphinx.ext.autosectionlabel'
3533
]
3634

3735
# Add any paths that contain templates here, relative to this directory.
@@ -48,7 +46,7 @@
4846
# The theme to use for HTML and HTML Help pages. See the documentation for
4947
# a list of builtin themes.
5048
#
51-
html_theme = 'sphinx_rtd_theme'
49+
html_theme = 'alabaster'
5250

5351
# Add any paths that contain custom static files (such as style sheets) here,
5452
# relative to this directory. They are copied after the builtin static files,

docs/requirements.txt

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
sphinx==4.2.0
2-
sphinx_rtd_theme==1.0.0
3-
readthedocs-sphinx-search==0.1.1
1+
sphinx==8.0.2

0 commit comments

Comments
 (0)