search

slurpcode / slurp

One repo to rule them all !!?!?!! 🤓 😎
https://slurp.rtfd.io/
GNU General Public License v3.0
53 stars 76 forks source link

Basic Setup: Learn to add a doc #1889

Open jbampton opened 2 years ago

jbampton commented 2 years ago

Documentation

Python Sphinx based slurp documentation site written mainly in Markdown. We have a local requirements file just for the Read the Docs hosting in the doc folder

cd doc || exit
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt

Files are stored in doc/source. From the doc folder you can build the HTML output files which are stored in doc/build. These local build files are ignored from Git.

cd doc || exit
make html

On Read the Docs we also have PDF and Epub versions

Vishrut19 commented 2 years ago

Hello @jbampton I was not able to setup the project on my system due to some issue. Can you please come to discord voice channel and I will share my screen. So please help?

jbampton commented 1 year ago

https://slurp.readthedocs.io/en/latest/getting-started.html#documentation