Commit 38f1d2b5 authored by Roel Aaij's avatar Roel Aaij
Browse files

Update/fix docs

parent b098566f
......@@ -10,51 +10,7 @@ Installation
**On Unix (Linux, OS X)**
- clone this repository
- `pip install ./KM3NeT-generator`
**On Windows (Requires Visual Studio 2015)**
- For Python 3.5:
- clone this repository
- `pip install ./KM3NeT-generator`
- For earlier versions of Python, including Python 2.7:
xtensor requires a C++14 compliant compiler (i.e. Visual Studio 2015 on
Windows). Running a regular `pip install` command will detect the version
of the compiler used to build Python and attempt to build the extension
with it. We must force the use of Visual Studio 2015.
- clone this repository
- `"%VS140COMNTOOLS%\..\..\VC\vcvarsall.bat" x64`
- `set MSSdk=1`
- `pip install ./KM3NeT-generator`
Note that this requires the user building `KM3NeT-generator` to have registry edition
rights on the machine, to be able to run the `vcvarsall.bat` script.
Windows runtime requirements
On Windows, the Visual C++ 2015 redistributable packages are a runtime
requirement for this project. It can be found [here](
If you use the Anaconda python distribution, you may require the Visual Studio
runtime as a platform-dependent runtime requirement for you package:
- python
- setuptools
- pybind11
- python
- vs2015_runtime # [win]
- `pip install ./k40gen`
Building the documentation
......@@ -65,7 +21,7 @@ the extension module to generate beautiful documentation in a variety formats.
The following command generates HTML-based reference documentation; for other
formats please refer to the Sphinx manual:
- `KM3NeT-generator/docs`
- `k40gen/docs`
- `make html`
......@@ -6,5 +6,4 @@ Contents:
.. toctree::
:maxdepth: 1
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment