Project documentation wesbite using Sphinx - Githubissues

mahakanakala / toxins-in-skincare

A data analysis and visualization of skincare/makeup products using Seaborn & Plotly.

https://whats-in-your-skincare.vercel.app/about

0 stars 0 forks source link

Project documentation wesbite using Sphinx #10

Closed mahakanakala closed 1 year ago

mahakanakala commented 1 year ago

Sphinx is a document manager that automatically creates a website with all of the documentation so as not to bombard the `README.md` & `ProjectSetup.md`

install Sphinx usingpip3 install sphinx
choose the Sphinx theme from here
update the conf.py file to use Sphinx and set the theme to choose one
run make HTML in the docs directory

Things to include in documentation website

[x] Project description
[x] README
[x] ProjectSetup
[x] Github repo
[x] Notion notes