|
0
|
1 General information
|
|
|
2 ===================
|
|
|
3
|
|
268
|
4 Orthanc is a lightweight, RESTful Vendor Neutral Archive for
|
|
|
5 DICOM. General information about Orthanc can be found on its
|
|
|
6 [official Website](http://www.orthanc-server.com/).
|
|
0
|
7
|
|
268
|
8 This repository contains the source code of the
|
|
|
9 [Orthanc Book](http://book.orthanc-server.com/), that documents how
|
|
|
10 Orthanc can be used. It also contains the source code of the
|
|
|
11 documentation of the
|
|
|
12 [REST API of Orthanc](http://api.orthanc-server.com/). The continuous
|
|
|
13 integration server (CIS) of Orthanc watches this repository, and
|
|
|
14 automatically publishes modifications online.
|
|
0
|
15
|
|
268
|
16 Improvements that should be done in the documentation can be reported
|
|
|
17 onto the
|
|
|
18 [dedicated issue tracker](https://bitbucket.org/sjodogne/orthanc-book/issues?status=new&status=open).
|
|
0
|
19
|
|
|
20
|
|
268
|
21 Orthanc Book
|
|
|
22 ============
|
|
|
23
|
|
0
|
24 Setup
|
|
151
|
25 -----
|
|
|
26
|
|
268
|
27 To build the Orthanc Book from sources, you need to install
|
|
|
28 [Sphinx](http://www.sphinx-doc.org/), the Python Documentation
|
|
|
29 Generator.
|
|
0
|
30
|
|
151
|
31
|
|
|
32 ### Installing Sphinx under Ubuntu 14.04 LTS ###
|
|
|
33
|
|
|
34 # sudo pip install sphinx sphinx_bootstrap_theme
|
|
0
|
35
|
|
|
36
|
|
268
|
37 Generating the Book
|
|
|
38 -------------------
|
|
151
|
39
|
|
|
40 ### Under Linux ###
|
|
0
|
41
|
|
151
|
42 # cd ./Sphinx
|
|
|
43 # make html
|
|
|
44
|
|
|
45 The HTML documentation will be available in the folder
|
|
|
46 `./build/html`. You can for instance open it using Mozilla Firefox as
|
|
|
47 follows:
|
|
|
48
|
|
|
49 # firefox ./build/html/index.html
|
|
0
|
50
|
|
|
51
|
|
268
|
52 Contributing to the Book
|
|
|
53 ------------------------
|
|
0
|
54
|
|
268
|
55 * Make sure to understand the
|
|
|
56 [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText).
|
|
151
|
57 * Fork this repository onto your BitBucket account.
|
|
268
|
58 * Edit the content of the
|
|
|
59 [`./Sphinx/source/` folder](./Sphinx/source/).
|
|
|
60 * Generate locally the Orthanc Book (cf. above), and make sure it
|
|
|
61 displays properly on your computer.
|
|
|
62 * Submit a
|
|
|
63 [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html)
|
|
|
64 for review by the Orthanc project.
|
|
|
65 * Once the pull request is reviewed and accepted, the continuous
|
|
|
66 integration server of the Orthanc project will automatically
|
|
|
67 publish the new version [online](http://book.orthanc-server.com/).
|
|
|
68
|
|
|
69
|
|
|
70
|
|
|
71 REST API of Orthanc
|
|
|
72 ===================
|
|
|
73
|
|
|
74 Setup
|
|
|
75 -----
|
|
|
76
|
|
|
77 The REST API of Orthanc is documented according to the
|
|
|
78 [OpenAPI specification and in the YAML format](https://en.wikipedia.org/wiki/OpenAPI_Specification).
|
|
|
79
|
|
|
80 The source code of the OpenAPI documentation can be found in the file
|
|
|
81 [./OpenAPI/orthanc-openapi.yaml](./OpenAPI/orthanc-openapi.yaml)
|
|
|
82 within this repository.
|
|
|
83
|
|
|
84 Contributing to the OpenAPI
|
|
|
85 ---------------------------
|
|
|
86
|
|
|
87 * Make sure to understand the
|
|
|
88 [OpenAPI YAML format](https://swagger.io/specification/).
|
|
|
89 * Fork this repository onto your BitBucket account.
|
|
|
90 * Edit the content of the
|
|
|
91 [`./OpenAPI/orthanc-openapi.yaml` file](./OpenAPI/orthanc-openapi.yaml).
|
|
|
92 * Submit a
|
|
|
93 [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html)
|
|
|
94 for review by the Orthanc project.
|
|
|
95 * Once the pull request is reviewed and accepted, the continuous
|
|
|
96 integration server of the Orthanc project will automatically
|
|
|
97 publish the new version [online](http://api.orthanc-server.com/).
|
