Skip to content

Commit a7dfe58

Browse files
committed
Rename CodeDocs to codeDocs for naming consistency
- Renamed doc/CodeDocs/ to doc/codeDocs/ to follow repository naming conventions - Updated all references in GitHub Actions workflow (python-docs.yml) - Updated .gitignore paths to use codeDocs - Updated README.md to reflect new path - Updated codeDocs/README.md to use consistent naming throughout - Tested documentation build with new path - works correctly
1 parent cbb8d94 commit a7dfe58

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
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 doc/CodeDocs/ src/
30-
sphinx-build -b html doc/CodeDocs/ doc/CodeDocs/_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: doc/CodeDocs/_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-
doc/CodeDocs/_build/
300+
doc/codeDocs/_build/
301301
# Generated API documentation files
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
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-
📁 doc/ → Architecture, schema, guides, and API documentation (doc/CodeDocs/)
164+
📁 doc/ → Architecture, schema, guides, and API documentation (doc/codeDocs/)
165165
📁 deployments/ → Docker, Kubernetes, Helm, monitoring
166166
```
167167

doc/CodeDocs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Code Documentation (CodeDocs)
1+
# Code Documentation (codeDocs)
22

33
This directory contains the auto-generated API documentation for the unstructuredDataHandler project using Sphinx.
44

@@ -20,21 +20,21 @@ To build the documentation locally:
2020
pip install -r requirements-docs.txt
2121

2222
# Generate API documentation
23-
sphinx-apidoc -o doc/CodeDocs/ src/
23+
sphinx-apidoc -o doc/codeDocs/ src/
2424

2525
# Build HTML documentation
26-
sphinx-build -b html doc/CodeDocs/ doc/CodeDocs/_build/html
26+
sphinx-build -b html doc/codeDocs/ doc/codeDocs/_build/html
2727
```
2828

29-
The built documentation will be available in `doc/CodeDocs/_build/html/index.html`.
29+
The built documentation will be available in `doc/codeDocs/_build/html/index.html`.
3030

3131
## Automated Builds
3232

3333
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.
3434

3535
## Relationship to Main Documentation
3636

37-
This CodeDocs directory focuses specifically on API documentation generated from source code docstrings. For other types of documentation:
37+
This codeDocs directory focuses specifically on API documentation generated from source code docstrings. For other types of documentation:
3838

3939
- Architecture documentation → `doc/architecture/`
4040
- Business documentation → `doc/business/`

0 commit comments

Comments
 (0)