jpartain89 / Software-Install-Guides

My files for building my Software Installation Guides Website

Home Page:docs.jpcdi.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Software Install Guides

RTD Build

Documentation Status

My personal reStructuredText - rst - files for my Software Installation Guides.

The majority of these guides are the ones that I find myself - time and time again - repeatedly having to revist in order to either; build, rebuild or re-aquaint myself with some point of knowledge.

I have these docs - both self-hosted and being hosted - on ReadTheDocs.org at docs.jpcdi.com. The ReadTheDocs hosting part was a recent occurrence. Currently, my NGINX-based server is reverse-proxying out to ReadTheDocs.

To Install Sphinx Stuff

Its best to utilize Homebrew team's python and pip packages, making sure that its going to be python 3 that will be installed on your system. Python 2 is being phased out and Python 3 is just plain better.

Run ./scripts/install.sh. It utilizes pip3 to install the required python programs.

If you want to just run the tests without the documents being built, run make local-tests. Otherwise, you can run make build to clean out any old documentation, then it runs linkcheck, tests building and then actually builds the documentation.

Version 5.0.0

This version is a big jump due to RTD's new .readthedocs.yaml file requirements, which breaks this project, 'technicaly' from v4.0.0 to now.

About

My files for building my Software Installation Guides Website

docs.jpcdi.com

License:MIT License


Languages

Language:JavaScript 59.0%Language:Batchfile 22.1%Language:Python 7.7%Language:Makefile 6.8%Language:HTML 2.2%Language:Shell 2.0%