mirror of https://github.com/nicolargo/glances.git
66e7916fbf
Several typos were found and corrected in the project documentation. Additionally, a number of grammatical and stylistic improvements were made to enhance clarity and coherence. These changes affect the following files: - docs/api.rst - docs/cmds.rst - docs/config.rst - docs/docker.rst - docs/glances.rst - docs/index.rst - docs/install.rst - docs/quickstart.rst - docs/support.rst These corrections and improvements significantly enhance the readability and accuracy of the documentation, making it more accessible and comprehensible for both users and developers. |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| aoa | ||
| dev | ||
| gw | ||
| man | ||
| Makefile | ||
| README.txt | ||
| api.rst | ||
| build.sh | ||
| cmds.rst | ||
| conf.py | ||
| config.rst | ||
| docker.rst | ||
| faq.rst | ||
| glances.rst | ||
| index.rst | ||
| install.rst | ||
| make.bat | ||
| objects.inv | ||
| quickstart.rst | ||
| support.rst | ||
README.txt
Building the docs
=================
First install Sphinx and the RTD theme:
make venv
or update it if already installed:
make venv-upgrade
Go to the docs folder:
cd docs
Then build the HTML documentation:
make html
and the man page:
LC_ALL=C make man