Last update: 2020/04/01 12:44 usage:faq https://dokuwiki.librecad.org/doku.php/usage:faq?rev=1585745094
https://dokuwiki.librecad.org/ Printed on 2024/09/15 21:58
Host User Manual Locally
How can I use User Manual Offline?
Purpose:
Allow Read the Docs files to be viewed offline
Make edits to the docs themselves and render them locally so you can inspect changes before
pushing back to the fork
Install:
Python 3.7.6 - Note: current bug in v3.8
pip install Sphinx
pip install sphinx-autobuild
pip install sphinx-rtd-theme
Download https://github.com/LibreCAD/docs/archive/master.zip from a fork of your choice and
Unzip to a directory
Run:
Navigate to the directory in Explorer and on the address bar enter make livehtml to start the
local server
In your browser enter http://127.0.0.1:8000
If you make any changes to the local User Manual files they will be updated in the browser.
Contribute on GitHub
Can I easily contribute on GitHub?
Yes, with a simple pull request. You will need to register a GitHub account, login then go to the page.
For example, click the Edit on GitHub link in the top right-hand corner of any User Manual page to go
to the page.
Click the pencil button, make any edits you want and preview them to confirm. Give the
proposed change a description up to 50 characters and optionally an extended description then
click the Propose file Change button.
If you're reading this you won't have write access to the repository so GitHub will create a copy
of the repository as a branch of a fork in your account. Click the Create pull request button.
Give the Pull Request a description and add any comments then click Create pull request.
Many GitHub files are in a special format, for example, the User Manual uses reStructuredText. If the
change is simple you might be able to stay within existing formatting or perhaps copy a similar
formatted section from elsewhere and change it. If you mess it up get help or submit it anyway and
let the repository owner fix it.
Each contribution should have its own branch so just start again. If you missed something in the pull