PipeCraft2

This is repo for PipeCraft2 user guide https://pipecraft2-manual.rtfd.io/

PipeCraft2 development repo -> https://github.com/pipecraft2/pipecraft

---

For developers

Requirements: git, python, sphinx.

1. Check if git is installed (through command line)

git --version

If git is not installed, then install it For Windows: https://git-scm.com/install/windows For Linux: sudo apt install git-all For MacOS: git --version (it will prompt the install)

2. Download github repository

cd C:/Users/user/Desktop  # go to directory where you want to place the github repo
git clone https://github.com/pipecraft2/user_guide.git

cd C:/Users/user/Desktop/user_guide/doc  # go to downloaded github repo
git checkout 1.1.0 # Switch to the brach you are developing!

3. Install sphinx and other requirements: (make sure python is installed)

cd C:/Users/user/Desktop/user_guide/doc  # go to downloaded github repo
python -m pip install -U sphinx
python -m pip install -r requirements.txt


### If you have problems installing as an admin then try:
cd C:/Users/user/Desktop/user_guide/doc  # go to github repo
python -m pip install --user sphinx
python -m pip install --user -r requirements.txt

4. Build local page for testing (in user_guide/doc)

For Windows:

# in doc dir
.\make.bat html

If you installed sphinx with --user and make.bat doesn't work, use:

# in doc dir
python -m sphinx -M html . _build

For Linux and macOS:

# in doc dir
make html

Open any html file in the "user_guide/doc/_build/html" directory to check the page build.

6. Edit the *.rst files as needed. Then build locally (point 4 above) to check the page before pushing.

If changes do not appear, then remove the "_build" folder and build again:

# in doc dir
rm -r _build
.\make.bat html

7. When edis are done, then push changes to github

git add .    # adds all changes 
git commit -m "describe my edits" # add a brief message what was changed
git push     # push changes to github

After the "git push" the webpage will automatically update itself.