Skip to content

Commit 2e71c55

Browse files
committed
Move API docs to api-docs directory, update code comments and enable markdown code fences, move info on API doc generation to proj. contrib.
1 parent 2c2f5b6 commit 2e71c55

File tree

10 files changed

+107
-1414
lines changed

10 files changed

+107
-1414
lines changed

.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,10 @@ wheels/
4242
*.egg
4343

4444
# Sphinx docs
45-
docs/_build
46-
docs/_static
45+
api-docs/api
46+
api-docs/_build
47+
api-docs/_static
48+
api-docs/_preprocessed
4749

4850
# PyInstaller
4951
# Usually these files are written by a Python script from a template

README.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,32 +38,7 @@ See the [`examples` directory](https://github.com/contentauth/c2pa-python/tree/m
3838

3939
## API reference documentation
4040

41-
You can generate API docs with one command. How to use:
42-
43-
Install dev deps:
44-
```
45-
cd c2pa-python
46-
python3 -m pip install -r requirements-dev.txt
47-
```
48-
49-
Build docs:
50-
51-
```
52-
make -C docs
53-
```
54-
55-
Output:
56-
57-
```
58-
Open docs/build/html/index.html
59-
```
60-
61-
This uses `sphinx-autoapi` to parse `src/c2pa` directly, avoiding imports of native libs.
62-
- Entry script: `scripts/generate_api_docs.py`
63-
- Config: `docs/conf.py`; index: `docs/index.rst`
64-
65-
Sphinx config is in `docs/conf.py`, an `index.rst`, added `scripts/generate_api_docs.py`, updated `requirements-dev.txt` with `Sphinx/AutoAPI/Myst/Furo`, and added a docs Makefile target.
66-
41+
See [the section in Contributing to the project](https://github.com/contentauth/c2pa-python/blob/main/docs/project-contributions.md#api-reference-documentation).
6742

6843
## Contributing
6944

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)