Skip to content

Commit a1b5fed

Browse files
committed
chore: setup readme
1 parent eb046ce commit a1b5fed

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ jobs:
3636
pip install sphinx sphinx_rtd_theme myst_parser
3737
- name: build docs
3838
run: |
39+
mv README.rst index.rst
3940
./build.sh
4041
- name: Setup Pages
4142
uses: actions/configure-pages@v5

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Nanoforge Documentation
2+
=======================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
cli/index.rst
8+
engine/index.rst
9+
10+
this is a basic documentation project
11+
[![Deploy Pages](https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml)

index.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)