forked from MariaDB/mariadb-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve documentation for Linux installation
For installation, it's recommended to use python virtualenvironments on Linux. The size of the font for the TOC needed increase to fix a bad alignment that seems to happen only on Linux.
- Loading branch information
Showing
4 changed files
with
24 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
*.exe | ||
*.py[cod] | ||
.envrc | ||
__pycache__/ | ||
outline | ||
output_* | ||
outline |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,37 @@ | ||
# mariadb_pdf | ||
|
||
## Installation | ||
|
||
- install [python](https://www.python.org/downloads/) `(3.10+)` | ||
- install [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html) (if on windows copy wkhtmltopdf.exe to this directory) | ||
- Install python packages with (pip/pip3) | ||
- Install python packages with (pip/pip3): | ||
- toml | ||
- pdfkit | ||
- requests | ||
- bs4 | ||
|
||
If you are on Linux (not tested on MacOS or Windows), you can setup a virtual | ||
environment with the following commands (needs `virtualenv`): | ||
|
||
```console | ||
virtualenv .venv | ||
source .venv/bin/activate | ||
pip3 install -r requirements.txt | ||
``` | ||
|
||
## Usage | ||
|
||
- make sure | ||
[mariadb_kb_server](https://github.com/icerath/mariadb_kb_server) | ||
- make sure [mariadb_kb_server](https://github.com/icerath/mariadb_kb_server) | ||
is running. | ||
- run `'(python/python3) main.py'` | ||
|
||
|
||
|
||
## Dependencies | ||
- python 3.10 + | ||
- wkhtmltopdf | ||
|
||
See [requirements.txt](./requirements.txt). | ||
|
||
### Libraries | ||
|
||
- toml | ||
- pdfkit | ||
- requests | ||
- bs4 | ||
- bs4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
bs4 | ||
pdfkit | ||
requests | ||
toml |