Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
73ba427b
Commit
73ba427b
authored
Dec 19, 2018
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add Make recipes for buildout and Sphinx and update docs
parent
d109f0a9
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
16 additions
and
20 deletions
+16
-20
Makefile
Makefile
+10
-1
docs/source/documentation.rst
docs/source/documentation.rst
+6
-19
No files found.
Makefile
View file @
73ba427b
...
@@ -234,8 +234,17 @@ check: eslint
...
@@ -234,8 +234,17 @@ check: eslint
########################################################################
########################################################################
## Documentation
## Documentation
./bin/activate
:
virtualenv .
.installed.cfg
:
requirements.txt buildout.cfg
./bin/pip
install
-r
requirements.txt
./bin/buildout
-v
docsdev
:
./bin/activate .installed.cfg
.PHONY
:
html
.PHONY
:
html
html
:
apidoc
html
:
docsdev
apidoc
rm
-rf
$(BUILDDIR)
/html
rm
-rf
$(BUILDDIR)
/html
$(SPHINXBUILD)
-b
html
$(ALLSPHINXOPTS)
$(BUILDDIR)
/html
$(SPHINXBUILD)
-b
html
$(ALLSPHINXOPTS)
$(BUILDDIR)
/html
make apidoc
make apidoc
...
...
docs/source/documentation.rst
View file @
73ba427b
...
@@ -30,33 +30,20 @@ under ``docs/source``.
...
@@ -30,33 +30,20 @@ under ``docs/source``.
How to generate HTML from the source files?
How to generate HTML from the source files?
===========================================
===========================================
Install Dependencies
--------------------
In order to generate HTML from the source files, you need to have Sphinx and
the `Sphinx Bootstrap Theme <http://ryan-roemer.github.io/sphinx-bootstrap-theme>`_
installed.
We use `zc.buildout <http://www.buildout.org/en/latest/>`_ to install Sphinx
and the theme.
To install Sphinx, do the following inside the Converse repo::
virtualenv .
source bin/activate
pip install -r requirements.txt
./bin/buildout
Generate the HTML
Generate the HTML
-----------------
-----------------
After installing the dependencies, you can generate the HTML by simply
After installing the dependencies, you can generate the HTML by running::
running::
make html
make html
The HTMl files will be located in ``./docs/html``
The HTMl files will be located in ``./docs/html``
What ``make html`` does for you is it installs `zc.buildout <http://www.buildout.org/en/latest/>`_
which is used to install Sphinx and all its dependencies.
You'll need to have Python and `Virtualenv <https://virtualenv.pypa.io/en/latest/>`_ available on your computer.
.. warning:: When contributing, please don't commit any generated html files.
.. warning:: When contributing, please don't commit any generated html files.
Serving the documentation
Serving the documentation
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment