manual/README.md

28 lines
2.0 KiB
Markdown
Raw Normal View History

2016-08-04 10:11:00 -05:00
# Lubuntu Manual Source Code
2020-05-16 19:19:57 -07:00
This is the Lubuntu Manual source code. The concept was derived from [the Kubuntu Manual](https://github.com/ahoneybun/kubuntu-manual). The master branch of this data is now on LXQt for Lubuntu 18.10+ and if you want code for earlier versions it is on the LXDE branch. For each relase of a distro go to the numerical number of that release such as 19.10. To see what is currently in master [manual master branch](https://manual.lubuntu.me/master/) and to see the current stable version look at [stable manual branch](https://manual.lubuntu.me/stable/) . To see what is currently for LTS releseases are hosted at [manual lts branch](https://manual.lubuntu.me/lts/)
2016-08-04 10:11:00 -05:00
## How it works
The documentation is powered by [Sphinx](http://www.sphinx-doc.org/en/stable/) and is written in reStructuredText.
2016-08-04 10:11:00 -05:00
2016-08-04 21:00:15 -05:00
Run the following command to install the needed dependencies:
```
2022-11-17 20:27:32 -08:00
sudo apt install python3-pip python3-sphinx latexmk texlive texlive-formats-extra python3-sphinx-rtd-theme python3-sphinx-bootstrap-theme
2016-08-04 21:00:15 -05:00
```
2019-02-14 15:03:07 -08:00
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`.
2016-08-04 10:11:00 -05:00
## Contributing
To contribute to the Lubuntu Manual, you can either create a request on Launchpad, or send patch mail to [lubuntu-devel@lists.ubuntu.com](mailto:lubuntu-devel@lists.ubuntu.com) and prefix the subject with `[Lubuntu Manual Pull Request]`.
2016-08-04 10:11:00 -05:00
2020-05-16 19:22:45 -07:00
If you really want to learn more about sphinx Lyn Perrine found this pycon video helpful [Carol_Willing-Practical_Sphinx] (https://www.youtube.com/watch?v=0ROZRNZkPS8)
2019-11-12 14:46:49 -08:00
If you want short help on how to format things see StyleGuide.rst in this directory.
2016-08-04 10:11:00 -05:00
## License
This work is licensed under a Creative Commons Attribution 4.0 International License. More details can be found here: [creative commons attribution license](http://creativecommons.org/licenses/by/4.0/)