plano/docs
Salman Paracha 976b2eaae0
fixing docs so that GH pages picks up the right CNAME for DNS (#135)
* fixing docs so that GH pages picks up the right CNAME for DNS

* updating workflow to pick CNAME

* making sure to correctly set permissions on the build/html directory

* fixing GH actions issues with CNAME

* updated docker build command to run as local user

* fixed the CNAME issue and udpated GH actions

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
2024-10-07 11:03:02 -07:00
..
source Doc Update (#129) 2024-10-06 16:54:34 -07:00
build_docs.sh fixing docs so that GH pages picks up the right CNAME for DNS (#135) 2024-10-07 11:03:02 -07:00
CNAME fixing docs so that GH pages picks up the right CNAME for DNS (#135) 2024-10-07 11:03:02 -07:00
Dockerfile add readme and docker build (#81) 2024-09-25 10:05:59 -07:00
Makefile Docs branch - v1 of our tech docs (#69) 2024-09-20 17:08:42 -07:00
README.md add readme and docker build (#81) 2024-09-25 10:05:59 -07:00
requirements.txt Doc Update (#129) 2024-10-06 16:54:34 -07:00

Generate HTML from reStructuredText files

To generate docs execute following command,

sh build_docs.sh

Requirements

This build system requires docker to be intsalled and running locally.