Lubuntu/manual
11
3
Fork 1
Code Issues Pull Requests Releases Activity

Add changes for using git version as PYPI is broken

Browse Source
This commit is contained in:
Lyn Perrine 2019-04-02 16:26:03 -07:00
parent 5b01a49d9d
commit 33a1837c6e
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -19,8 +19,8 @@ Before starting, you need a few tools.
- `texlive-formats-extra` - `texlive-formats-extra`
- `latexmk` - `latexmk`
- `python3-sphinx-rtd-theme` - `python3-sphinx-rtd-theme`
- The following package from PyPI - The following code from git
- `pip3 install sphinxcontrib-versioning` - git clone https://github.com/sphinxcontrib-versioning-ng/sphinxcontrib-versioning
## Getting the code ## 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! 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 ## Making changes and seeking your changes to be pulled
**Before you do the below, please update PROGRESS.md to reflect your changes.** **Before you do the below, please update PROGRESS.md to reflect your changes.**

2
README.md
View File

@ -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: 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`. 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`.