File: README.md

package info (click to toggle)
pyscanfcs 0.3.6%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,412 kB
  • sloc: python: 2,676; makefile: 55; sh: 11
file content (20 lines) | stat: -rw-r--r-- 484 bytes parent folder | download | duplicates (5) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
PyScanFCS documentation
=======================
This is the new sphinx-based documentation of PyScanFCS 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 PyScanFCS, run

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