Mercurial > hg > orthanc-book
annotate README.md @ 916:dafff7d1c975
fix
author | Alain Mazy <am@osimis.io> |
---|---|
date | Tue, 07 Feb 2023 15:26:12 +0100 |
parents | 502ac2047b9b |
children | 1316bc62b5d5 |
rev | line source |
---|---|
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 |
16 | |
268 | 17 Orthanc Book |
18 ============ | |
19 | |
0 | 20 Setup |
151 | 21 ----- |
22 | |
268 | 23 To build the Orthanc Book from sources, you need to install |
24 [Sphinx](http://www.sphinx-doc.org/), the Python Documentation | |
25 Generator. | |
0 | 26 |
151 | 27 |
28 ### Installing Sphinx under Ubuntu 14.04 LTS ### | |
29 | |
30 # sudo pip install sphinx sphinx_bootstrap_theme | |
0 | 31 |
32 | |
268 | 33 Generating the Book |
34 ------------------- | |
151 | 35 |
36 ### Under Linux ### | |
0 | 37 |
151 | 38 # cd ./Sphinx |
39 # make html | |
40 | |
41 The HTML documentation will be available in the folder | |
42 `./build/html`. You can for instance open it using Mozilla Firefox as | |
43 follows: | |
44 | |
45 # firefox ./build/html/index.html | |
0 | 46 |
47 | |
268 | 48 Contributing to the Book |
49 ------------------------ | |
0 | 50 |
268 | 51 * Make sure to understand the |
52 [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText). | |
151 | 53 * Fork this repository onto your BitBucket account. |
268 | 54 * Edit the content of the |
55 [`./Sphinx/source/` folder](./Sphinx/source/). | |
56 * Generate locally the Orthanc Book (cf. above), and make sure it | |
57 displays properly on your computer. | |
58 * Submit a | |
59 [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html) | |
60 for review by the Orthanc project. | |
61 * Once the pull request is reviewed and accepted, the continuous | |
62 integration server of the Orthanc project will automatically | |
63 publish the new version [online](http://book.orthanc-server.com/). | |
64 | |
65 | |
66 | |
67 REST API of Orthanc | |
68 =================== | |
69 | |
583
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
70 The REST API of Orthanc is now fully documented in the [source code of |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
71 the Orthanc |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
72 server](https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Sources/OrthancRestApi). |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
73 The `--openapi=` and the `--cheatsheet=` command-line options of |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
74 Orthanc automatically generate respectively the [OpenAPI in JSON |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
75 format](https://swagger.io/specification/) and its [quick reference |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
76 (cheatsheet)](https://book.orthanc-server.com/users/rest-cheatsheet.html) |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
77 in CSV format that is designed to be included right into the [Orthanc |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
78 Book](https://hg.orthanc-server.com/orthanc-book/file/default/Sphinx/source/users/rest-cheatsheet.csv). |
268 | 79 |
583
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
80 In order to contribute to the documentation of the REST API, you can |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
81 [propose a simple |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
82 patch](https://book.orthanc-server.com/developers/repositories.html#simple-patch-import-export) |
502ac2047b9b
fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
296
diff
changeset
|
83 to the core of Orthanc to be reviewed by the core maintainers. |