Skip to content

Commit cbb8d94

Browse files
committed
Reorganize documentation: Move docs to doc/CodeDocs for clarity
- Moved docs/ folder to doc/CodeDocs/ to better organize documentation - Updated GitHub Actions workflow to use new path (doc/CodeDocs/) - Updated .gitignore to reflect new documentation paths - Updated README.md to document the new structure - Added README.md in CodeDocs explaining its purpose and relationship to main docs - This provides clear separation between auto-generated API docs (CodeDocs) and human-written documentation (architecture, business, guides in doc/)
1 parent 1cf55c2 commit cbb8d94

File tree

6 files changed

+53
-11
lines changed

6 files changed

+53
-11
lines changed

.github/workflows/python-docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ jobs:
2626
install-docs-reqs: 'true'
2727
- name: Generate Sphinx docs
2828
run: |
29-
sphinx-apidoc -o docs/ src/
30-
sphinx-build -b html docs/ docs/_build/html
29+
sphinx-apidoc -o doc/CodeDocs/ src/
30+
sphinx-build -b html doc/CodeDocs/ doc/CodeDocs/_build/html
3131
- name: Upload documentation artifact
3232
uses: actions/upload-artifact@v4
3333
with:
3434
name: sphinx-docs
35-
path: docs/_build/html
35+
path: doc/CodeDocs/_build/html

.gitignore

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -297,11 +297,11 @@ coverage.xml
297297

298298
#Ignore vscode AI rules
299299
.github/instructions/codacy.instructions.md
300-
docs/_build/
300+
doc/CodeDocs/_build/
301301
# Generated API documentation files
302-
docs/modules.rst
303-
docs/app.rst
304-
docs/llm.rst
305-
docs/parsers.rst
306-
docs/parsers.database.rst
307-
docs/utils.rst
302+
doc/CodeDocs/modules.rst
303+
doc/CodeDocs/app.rst
304+
doc/CodeDocs/llm.rst
305+
doc/CodeDocs/parsers.rst
306+
doc/CodeDocs/parsers.database.rst
307+
doc/CodeDocs/utils.rst

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ If you would like to contribute to the documentation, please submit a pull reque
161161
📁 notebooks/ → Quick experiments and prototyping
162162
📁 src/ → The core engine — all logic lives here (./src/README.md)
163163
📁 tests/ → Unit, integration, and end-to-end tests
164-
📁 docs/ → Architecture, schema, guides
164+
📁 doc/ → Architecture, schema, guides, and API documentation (doc/CodeDocs/)
165165
📁 deployments/ → Docker, Kubernetes, Helm, monitoring
166166
```
167167

doc/CodeDocs/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Code Documentation (CodeDocs)
2+
3+
This directory contains the auto-generated API documentation for the unstructuredDataHandler project using Sphinx.
4+
5+
## Contents
6+
7+
- `conf.py` - Sphinx configuration file
8+
- `index.rst` - Main documentation index
9+
- `_static/` - Static files for documentation (CSS, images, etc.)
10+
- `_templates/` - Custom documentation templates
11+
- `_build/` - Generated HTML documentation (auto-generated, not committed)
12+
- `*.rst` - Auto-generated API documentation files (not committed)
13+
14+
## Building Documentation
15+
16+
To build the documentation locally:
17+
18+
```bash
19+
# Install documentation dependencies
20+
pip install -r requirements-docs.txt
21+
22+
# Generate API documentation
23+
sphinx-apidoc -o doc/CodeDocs/ src/
24+
25+
# Build HTML documentation
26+
sphinx-build -b html doc/CodeDocs/ doc/CodeDocs/_build/html
27+
```
28+
29+
The built documentation will be available in `doc/CodeDocs/_build/html/index.html`.
30+
31+
## Automated Builds
32+
33+
The documentation is automatically built and updated via GitHub Actions on every push that modifies Python files. See `.github/workflows/python-docs.yml` for the CI configuration.
34+
35+
## Relationship to Main Documentation
36+
37+
This CodeDocs directory focuses specifically on API documentation generated from source code docstrings. For other types of documentation:
38+
39+
- Architecture documentation → `doc/architecture/`
40+
- Business documentation → `doc/business/`
41+
- General guides and specs → `doc/`
42+
- Images and references → `doc/images/`, `doc/reference/`
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)