Add installation and releasenotes sections to the user manual.
This commit is contained in:
parent
61346ae95d
commit
6b8c54398d
12 changed files with 71 additions and 20 deletions
|
|
@ -22,7 +22,7 @@ copyright = '2021-2022, Eelke Klein'
|
|||
author = 'Eelke Klein'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = 'https://eelke.gitlab.io/pgLab/'
|
||||
# release = '1.0'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
|
@ -31,6 +31,7 @@ release = 'https://eelke.gitlab.io/pgLab/'
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'reno.sphinxext'
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
@ -54,4 +55,4 @@ html_theme_path = [sphinx_theme_pd.get_html_theme_path()]
|
|||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
html_static_path = []
|
||||
|
|
|
|||
|
|
@ -10,13 +10,12 @@ pgLab User Manual
|
|||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
releasenotes
|
||||
installation
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
|
||||
Fork this project
|
||||
==================
|
||||
|
||||
* https://eelke.gitlab.io/pgLab/
|
||||
|
|
|
|||
16
docs/installation.rst
Normal file
16
docs/installation.rst
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
Currently only binaries for Windows 64-bit are provided.
|
||||
|
||||
-------
|
||||
Windows
|
||||
-------
|
||||
|
||||
Downloads can be found `here <https://eelkeklein.stackstorage.com/s/E9xkMGQDFjHv5XN3>`_.
|
||||
|
||||
Unpack the contents of the 7zip archive to a folder of your choosing for instance
|
||||
`C:\\Program files\\pgLab`. You can run the pgLab.exe from there. If it is complaining
|
||||
about missing files this is probably because the required Visual C++ Runtime has
|
||||
not yet been installed on your machine you can get it from `microsoft <https://aka.ms/vs/17/release/vc_redist.x64.exe>`_.
|
||||
5
docs/releasenotes.rst
Normal file
5
docs/releasenotes.rst
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
============
|
||||
Releasenotes
|
||||
============
|
||||
|
||||
.. release-notes::
|
||||
Loading…
Add table
Add a link
Reference in a new issue