Skip to content

Commit ad7620f

Browse files
William Grantbraxtonmckee
authored andcommitted
add subheadings
1 parent 9e5e64e commit ad7620f

File tree

2 files changed

+21
-11
lines changed

2 files changed

+21
-11
lines changed

docs/index.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,26 @@
77
Welcome to typed_python's documentation!
88
========================================
99

10+
11+
1012
.. toctree::
11-
:maxdepth: 2
12-
:caption: Contents:
13+
:maxdepth: 1
14+
:caption: For Users
1315

1416
introduction.md
1517
intro_2.md
16-
modules
1718

18-
This is some stub documentation, which will one day be an API reference + a User Guide/Zoo + Developer's Guide.
19+
.. toctree::
20+
:maxdepth: 1
21+
:caption: For Developers
1922

23+
installation.md
24+
25+
.. toctree::
26+
:maxdepth: 3
27+
:caption: API documentation
2028

29+
api/typed_python
2130

2231

2332
Indices and tables

INSTALLATION.md renamed to docs/installation.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
## Development ##
1+
# Installation
2+
3+
## Development
24
There are several methods for building and setting up a development environment.
3-
5+
46
### Manual Method ###
57
1. Create a new virtualenv with Python 3.6 (`virtualenv --python=<path-to-py3> venv`) and source it
68
2. Install requirements via pip. For the moment there are two options:
79
* Install with plain pip using the `requirements`
810
* Install using Pipenv (which reads from the Pipfile)
911
3. Build nativepython libraries using `python setup.py build`
1012
4. Append the root of this repository to your `PYTHONPATH`
11-
12-
### Pipenv Method ###
13+
14+
## Pipenv Method ###
1315
This method is simple, and can take care of virtual environment creation and installation for you.
1416
1. (Optional) Create a new virtualenv with Python 3.6 (`virtualenv --python=<path-to-py3> venv`) and source it. If you choose to use Pipenv alone, it will create an appropriate virtualenv for you.
1517
2. Run `pipenv install --dev --deploy`
16-
18+
1719
### Makefile Method ###
1820
The included Makefile in this repository contains recipes for building, installing, and testing. For the moment, it is explicitly linked to a specific Python interpreter, so if you are using, say, an interpreter called `python3.6` (as opposed to `python3`), you will need to change the `PYTHON` variable at the top of the Makefile.
19-
21+
2022
You can also customize the name and location of any built virtual environments with the `VIRTUAL_ENV` variable.
2123

2224

@@ -51,4 +53,3 @@ Before building the modules in this repository, you will need to make sure that
5153
```
5254
* Pipenv ([see this link](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv))
5355
* Redis Server (`redis-server`)
54-

0 commit comments

Comments
 (0)