You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SYCLomatic documentation is written using [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) and built using [Sphinx](http://sphinx-doc.org/). Follow the instructions in this README to build the documentation locally.
4
+
5
+
## Requirements
6
+
7
+
The following must be installed to build the documentation:
8
+
9
+
- Python 3
10
+
- Sphinx
11
+
- Theme: sphinx_book_theme
12
+
13
+
## Contribute to the Documentation
14
+
15
+
Please make yourself familiar with the SYCLomatic [contribution guidelines](https://github.com/oneapi-src/SYCLomatic/blob/SYCLomatic/CONTRIBUTING.md) before submitting a contribution.
16
+
17
+
For documentation contributions in particular:
18
+
19
+
- The [DOC] tag should be present in the commit message title.
20
+
- Contributions should be tested (build with no errors) before submitting a PR.
21
+
- PRs should be granular and purpose specific: One PR should contain one unit of change.
22
+
- Submit content changes separate from formatting changes.
23
+
24
+
## Build the Documentation
25
+
26
+
You can build the documentation locally to preview your changes and make sure there are no errors. In the `docs` directory of your local SYCLomatic repository run:
27
+
28
+
make html
29
+
30
+
The generated HTML will be located in `docs/_build/html`.
31
+
32
+
When testing changes in the documentation, make sure to remove the previous build before building again. To do this run:
0 commit comments