|
0
|
1 General information
|
|
|
2 ===================
|
|
|
3
|
|
|
4 Orthanc is a lightweight, RESTful Vendor Neutral Archive for DICOM.
|
|
|
5
|
|
151
|
6 General information about Orthanc can be found on its [official Website](http://www.orthanc-server.com/).
|
|
0
|
7
|
|
151
|
8 This repository contains the source code of the [Orthanc Book](http://book.orthanc-server.com/), that documents how Orthanc can be used.
|
|
0
|
9
|
|
|
10
|
|
|
11 Setup
|
|
151
|
12 -----
|
|
|
13
|
|
|
14 To build the Orthanc Book from sources, you need to install [Sphinx](http://www.sphinx-doc.org/), the Python Documentation Generator.
|
|
0
|
15
|
|
151
|
16
|
|
|
17 ### Installing Sphinx under Ubuntu 14.04 LTS ###
|
|
|
18
|
|
|
19 # sudo pip install sphinx sphinx_bootstrap_theme
|
|
0
|
20
|
|
|
21
|
|
151
|
22 Generating the documentation
|
|
|
23 ----------------------------
|
|
|
24
|
|
|
25 ### Under Linux ###
|
|
0
|
26
|
|
151
|
27 # cd ./Sphinx
|
|
|
28 # make html
|
|
|
29
|
|
|
30 The HTML documentation will be available in the folder
|
|
|
31 `./build/html`. You can for instance open it using Mozilla Firefox as
|
|
|
32 follows:
|
|
|
33
|
|
|
34 # firefox ./build/html/index.html
|
|
0
|
35
|
|
|
36
|
|
151
|
37 How to contribute
|
|
|
38 -----------------
|
|
0
|
39
|
|
151
|
40 * Make sure to understand the [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText).
|
|
|
41 * Fork this repository onto your BitBucket account.
|
|
|
42 * Edit the content of the [`./Sphinx/source/` folder](./Sphinx/source/).
|
|
|
43 * Submit a [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html) for review by the Orthanc project.
|
|
|
44 * Once the pull request is reviewed, the continuous integration server of the Orthanc project will automatically publish the new version [online](http://book.orthanc-server.com/).
|
