File: README.md

package info (click to toggle)
pycorrfit 1.1.7%2Bnopack-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,652 kB
  • sloc: python: 15,100; makefile: 58; sh: 13
file content (20 lines) | stat: -rw-r--r-- 485 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
PyCorrFit documentation
=======================
This is the new sphinx-based documentation of PyCorrFit which will replace
the LaTeX-based documentation eventually.


To install the requirements for building the documentation, run

    pip install -r requirements.txt

To compile the documentation, run

    sphinx-build . _build


Notes
=====
To view the sphinx inventory of PyCorrFit, run

   python3 -m sphinx.ext.intersphinx 'http://pycorrfit.readthedocs.io/en/latest/objects.inv'