diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f183216f..de7c2645 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,8 @@ Before starting, you need a few tools. - `texlive-formats-extra` - `latexmk` - `python3-sphinx-rtd-theme` - - The following package from PyPI - - `pip3 install sphinxcontrib-versioning` + - The following code from git + - git clone https://github.com/sphinxcontrib-versioning-ng/sphinxcontrib-versioning ## Getting the code @@ -59,6 +59,9 @@ Contents Then run `make clean && make html && make latexpdf` in the root of the manual directory and it should build successfully! +## Getting mulitple Versions to Work +To change into the file for the code you cloned from git of sphinxconfig-versioning and run ``` cd sphinxcontrib-versioning && sudo python3 setup.py install``` + ## Making changes and seeking your changes to be pulled **Before you do the below, please update PROGRESS.md to reflect your changes.** diff --git a/README.md b/README.md index 3375c563..977f205a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The documentation is powered by [Sphinx](http://www.sphinx-doc.org/en/stable/) a Run the following command to install the needed dependencies: ``` -sudo apt install python3-pip python3-sphinx latexmk texlive texlive-formats-extra arcanist python3-sphinx-rtd-theme && pip3 install sphinxcontrib-versioning +sudo apt install python3-pip python3-sphinx latexmk texlive texlive-formats-extra arcanist python3-sphinx-rtd-theme && git clone https://github.com/sphinxcontrib-versioning-ng/sphinxcontrib-versioning ``` You can see the options for building the documentation by running `make help`. You can make the html version by running `make html`. You can make a pdf version of the lubuntu manual with `make latexpdf`. If you just want to check for warnings or errors building run `make dummy`.