Skip to content

Commit 3c95959

Browse files
author
fer
committed
feat: Disable GitHub Pages documentation, enable local-only builds
- Disable docs.yml and deploy-docs.yml workflows - Update README with local documentation instructions - Remove Documentation URL from pyproject.toml - Add .nojekyll file to prevent accidental GitHub Pages processing - Update documentation badge to reflect local build Documentation is now built locally using 'mkdocs serve' only.
1 parent 7961ec5 commit 3c95959

File tree

5 files changed

+55
-27
lines changed

5 files changed

+55
-27
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
name: Deploy Documentation to GitHub Pages
1+
name: Deploy Documentation to GitHub Pages (DISABLED)
22

3-
on:
4-
push:
5-
branches:
6-
- main
7-
paths:
8-
- 'docs/**'
9-
- 'mkdocs.yml'
10-
- '.github/workflows/deploy-docs.yml'
11-
- 'README.md'
12-
- 'src/**/README.md'
13-
- '*.md'
14-
workflow_dispatch:
3+
# DISABLED: Documentation now built locally only
4+
# To re-enable, remove this comment and uncomment the 'on' section below
5+
6+
# on:
7+
# push:
8+
# branches:
9+
# - main
10+
# paths:
11+
# - 'docs/**'
12+
# - 'mkdocs.yml'
13+
# - '.github/workflows/deploy-docs.yml'
14+
# - 'README.md'
15+
# - 'src/**/README.md'
16+
# - '*.md'
17+
# workflow_dispatch:
1518

1619
permissions:
1720
contents: write

.github/workflows/docs.yml

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
1-
name: Build and Deploy Documentation
1+
name: Build and Deploy Documentation (DISABLED)
22

3-
on:
4-
push:
5-
branches: [ main ]
6-
workflow_dispatch: {}
7-
pull_request:
8-
paths:
9-
- 'mkdocs.yml'
10-
- 'docs/**'
11-
- 'README.md'
12-
- 'src/**/README.md'
13-
- '*.md'
3+
# DISABLED: Documentation now built locally only
4+
# To re-enable, remove this comment and uncomment the 'on' section below
5+
6+
# on:
7+
# push:
8+
# branches: [ main ]
9+
# workflow_dispatch: {}
10+
# pull_request:
11+
# paths:
12+
# - 'mkdocs.yml'
13+
# - 'docs/**'
14+
# - 'README.md'
15+
# - 'src/**/README.md'
16+
# - '*.md'
1417

1518
jobs:
1619
build-deploy:

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![PyPI](https://img.shields.io/pypi/v/tnfr)](https://pypi.org/project/tnfr/)
99
[![Python](https://img.shields.io/pypi/pyversions/tnfr)](https://pypi.org/project/tnfr/)
1010
[![License](https://img.shields.io/github/license/fermga/TNFR-Python-Engine)](https://github.com/fermga/TNFR-Python-Engine/blob/main/LICENSE.md)
11-
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen)](https://fermga.github.io/TNFR-Python-Engine/)
11+
[![Documentation](https://img.shields.io/badge/docs-local%20build-brightgreen)](#-documentation)
1212

1313
**🎓 Academic Citation**: [DOI: 10.5281/zenodo.17602861](https://doi.org/10.5281/zenodo.17602861)
1414

@@ -41,6 +41,23 @@ If you use TNFR-Python-Engine in your research, please cite:
4141
**DOI**: [10.5281/zenodo.17602861](https://doi.org/10.5281/zenodo.17602861)
4242
**Author ORCID**: [0009-0007-6116-0613](https://orcid.org/0009-0007-6116-0613)
4343

44+
## 📖 Documentation
45+
46+
Documentation is built locally using MkDocs. To build and serve the documentation:
47+
48+
```bash
49+
# Install documentation dependencies
50+
pip install -e ".[docs]"
51+
52+
# Build and serve locally (auto-reload on changes)
53+
mkdocs serve
54+
55+
# Build static documentation
56+
mkdocs build # Output in site/
57+
```
58+
59+
The documentation will be available at `http://localhost:8000`
60+
4461
### Minimal Example
4562
```python
4663
from tnfr.sdk import TNFRNetwork

docs/.nojekyll

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# This file prevents GitHub Pages from processing the site with Jekyll
2+
# Documentation is now built locally only using MkDocs
3+
#
4+
# To build documentation locally:
5+
# 1. pip install -e ".[docs]"
6+
# 2. mkdocs serve

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,6 @@ PyPI = "https://pypi.org/project/tnfr/"
171171
Citation = "https://doi.org/10.5281/zenodo.17602861"
172172
Zenodo = "https://zenodo.org/records/17602861"
173173
Issues = "https://github.com/fermga/TNFR-Python-Engine/issues"
174-
Documentation = "https://fermga.github.io/TNFR-Python-Engine/"
175174
GPT = "https://chatgpt.com/g/g-67abc78885a88191b2d67f94fd60dc97-tnfr-resonant-fractal-nature-theory"
176175

177176
[tool.setuptools.package-data]

0 commit comments

Comments
 (0)