Skip to content

Commit 5156990

Browse files
authored
[SYCLomatic][DOC] Add README for docs (#804)
Add README with info re set up to build docs locally. Update conf.py to remove un-used extension. Signed-off-by: Kristal Dale <[email protected]>
1 parent 791c3b6 commit 5156990

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

docs/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Documentation Build Instructions
2+
3+
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:
33+
34+
make clean
35+
36+
37+

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
# Add any Sphinx extension module names here, as strings. They can be
3232
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3333
# ones.
34-
extensions = ['sphinx2dita']
34+
extensions = []
3535

3636
# Add any paths that contain templates here, relative to this directory.
3737
templates_path = ['_templates']

0 commit comments

Comments
 (0)