Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Commit

Permalink
refactor: Switch to pipenv
Browse files Browse the repository at this point in the history
  • Loading branch information
kylef committed Jan 23, 2019
1 parent c9c897f commit 0ac1cff
Show file tree
Hide file tree
Showing 4 changed files with 331 additions and 26 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Contributing to API Elements Documentation

The documentation is built using Sphinx, a Python tool. Assuming you have
Python 3 installed, the following steps can be used to build the site.
Python 3 and
[pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv)
installed, the following steps can be used to build the site.

```shell
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ pipenv install
```

## Running the Development Server

You can run a local development server to preview changes using the following:

```shell
$ make watch
$ pipenv run make watch
```
17 changes: 17 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]
sphinx = "*"
recommonmark = "*"
sphinx-rtd-theme = "*"
pygments-apiblueprint = "*"
pygments = "*"
sphinx-autobuild = "*"

[packages]

[requires]
python_version = "3.7"
282 changes: 282 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

48 changes: 27 additions & 21 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
alabaster==0.7.10
-i https://pypi.org/simple
alabaster==0.7.12
argh==0.26.2
Babel==2.5.3
certifi==2017.11.5
babel==2.6.0
certifi==2018.11.29
chardet==3.0.4
CommonMark==0.5.4
commonmark==0.8.1
docutils==0.14
idna==2.6
imagesize==0.7.1
Jinja2==2.10
livereload==2.5.1
MarkupSafe==1.0
future==0.17.1
idna==2.8
imagesize==1.1.0
jinja2==2.10
livereload==2.6.0
markupsafe==1.1.0
packaging==19.0
pathtools==0.1.2
port-for==0.3.1
Pygments==2.2.0
pytz==2017.3
PyYAML==3.12
recommonmark==0.4.0
requests==2.18.4
six==1.11.0
pygments-apiblueprint==0.1.0
pygments-markdown-lexer==0.1.0.dev39
pygments==2.3.1
pyparsing==2.3.1
pytz==2018.9
pyyaml==4.2b4
recommonmark==0.5.0
requests==2.21.0
six==1.12.0
snowballstemmer==1.2.1
Sphinx==1.6.6
sphinx-autobuild==0.7.1
sphinx-rtd-theme==0.3.1
sphinxcontrib-websupport==1.0.1
tornado==4.5.3
urllib3==1.22
watchdog==0.8.3
sphinx-rtd-theme==0.4.2
sphinx==1.8.3
sphinxcontrib-websupport==1.1.0
tornado==6.0a1
urllib3==1.24.1
watchdog==0.9.0

0 comments on commit 0ac1cff

Please sign in to comment.