Skip to content

Commit

Permalink
Remove recommonmark (unused)
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Sep 19, 2020
1 parent 0b02df2 commit 78fc178
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 46 deletions.
26 changes: 0 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,3 @@
# OCP Software Development Handbook

A guide for developers of OCP's tools.

This repository was originally based on OpenDataServices' [sphinx-base](https://github.com/OpenDataServices/sphinx-base). See its [instructions for ReadTheDocs setup](https://github.com/OpenDataServices/sphinx-base#building-on-readthedocs).

## Build and view the documentation

Create and activate a virtual environment, then install requirements:

```shell
pip install -r requirements.txt
```

And build the documentation:

```
cd docs
make html
```

The built documentation is in `_build/html` under `docs`. To view the documentation:

```shell
cd _build/html
python -m http.server
```

And open <http://localhost:8000/> in a browser.
18 changes: 2 additions & 16 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os

from recommonmark.transform import AutoStructify

# -- Path setup --------------------------------------------------------------

Expand All @@ -21,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = 'OCP Software Development Handbook'
copyright = '2017, Open Contracting Partnership'
copyright = '2020, Open Contracting Partnership'
author = 'Open Contracting Partnership'


Expand All @@ -30,9 +27,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark',
]
extensions = []

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -67,12 +62,3 @@
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]


def setup(app):
app.add_config_value('recommonmark_config', {
'auto_toc_tree_section': 'Contents',
'enable_eval_rst': True,
}, True)

app.add_transform(AutoStructify)
4 changes: 0 additions & 4 deletions requirements.txt

This file was deleted.

0 comments on commit 78fc178

Please sign in to comment.