Eclectic Media Git eclecti_deploy / b6977a2
Updated README to reflect new git frontend Ariana Giroux 6 months ago
2 changed file(s) with 41 addition(s) and 46 deletion(s). Raw diff Collapse all Expand all
0 Quickstart guide for eclecti_deploy
1 ===================================
2
3 ``eclecti_deploy`` provides custom deploy implementation for Eclectic Media Solutions Flask sites. It provides automated testing of operating system requirements, deployement of configuration files, and dependency management.
4
5 Installing from Source
6 ======================
7
8 To install from source, first clone the repository_: ::
9
10 git clone git://eclecticmedia.hopto.org/eclecti_deploy.git; cd eclecti_deploy
11
12 Then, with ``python3`` and ``pip`` installed, install the directory with: ::
13
14 python3 -m pip install .
15
16 Installing the Manpages
17 -----------------------
18
19 An ease of use command has been added to ``setup.py``, allowing you to simply run: ::
20
21 python3 setup.py install_docs
22
23 *note: You can uninstall the docs with ``setup.py`` via ``uninstall_docs``*
24
25 Building the Manpages
26 =====================
27
28 A convenience function has been added to ``setup.py``, allowing you to compile the docs with: ::
29
30 python3 setup.py build_sphinx
31
32 *Note: built pages located under ``docs/build/man``*
33
34 *Note: to view the manpages directly after compile, use ``python3 setup.py docs``.*
35
36 ----
37
38 Consult the manpages for more information
39
40 .. _repository: https://git.eclecticmedia.space/public/eclecti_deploy/
+0
-46
Readme.rst less more
0 Quickstart guide for eclecti_deploy
1 ===================================
2
3 ``eclecti_deploy`` provides custom deploy implementation for Eclectic Media Solutions Flask sites.
4
5 Installing from Source
6 ======================
7
8 To install from source, first clone the repository_:
9 ::
10
11 git clone git://eclecticmedia.hopto.org/eclecti_deploy.git; cd eclecti_deploy
12
13 Then, with ``python3`` and ``pip`` installed, install the directory with:
14 ::
15
16 python3 -m pip install .
17
18 Installing the Manpages
19 -----------------------
20
21 An ease of use command has been added to ``setup.py``, allowing you to simply run:
22 ::
23
24 python3 setup.py install_docs
25
26 .. note:: You can uninstall the docs with ``setup.py`` via ``uninstall_docs``
27
28 Building the Manpages
29 =====================
30
31 A convenience function has been added to ``setup.py``, allowing you to compile the docs with:
32 ::
33
34 python3 setup.py build_sphinx
35
36 .. note:: built pages located under ``docs/build/man``
37
38 .. note:: to view the manpages directly after compile, use ``python3 setup.py docs``.
39
40 ----
41
42 Consult the manpages for more information
43
44 .. _BurntToast: https://github.com/Windos/BurntToast
45 .. _repository: git-server:arianagiroux/eclecti_deploy.git