Add documentation on how to contribute to the docs.
This commit is contained in:
parent
84fd21b38b
commit
bcf47d6c7c
|
@ -112,7 +112,7 @@ module.exports = function(grunt) {
|
|||
// 'r.js -o src/build.js paths.converse-dependencies=src/deps-no-otr paths.locales=locale/nolocales out=builds/converse-no-locales-no-otr.min.js'
|
||||
});
|
||||
|
||||
grunt.registerTask('minify', 'Create a new release', ['cssmin', 'jsmin']);
|
||||
grunt.registerTask('minify', 'Create a new minified builds', ['cssmin', 'jsmin']);
|
||||
|
||||
grunt.registerTask('check', 'Perform all checks (e.g. before releasing)', function () {
|
||||
grunt.task.run('jshint', 'test');
|
||||
|
|
|
@ -3,7 +3,7 @@ Development
|
|||
===========
|
||||
|
||||
.. contents:: Table of Contents
|
||||
:depth: 3
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
If you want to work with the non-minified Javascript and CSS files you'll soon
|
||||
|
|
58
docs/source/documentation.rst
Normal file
58
docs/source/documentation.rst
Normal file
|
@ -0,0 +1,58 @@
|
|||
=====================
|
||||
Writing Documentation
|
||||
=====================
|
||||
|
||||
.. contents:: Table of Contents
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. note:: Contributions to the documentation are much appreciated.
|
||||
|
||||
What is used to write the documentation
|
||||
=======================================
|
||||
|
||||
This documentation is written in `Sphinx <http://sphinx-doc.org/>`_, a
|
||||
documentation generator written in `Python <http://python.org>`_.
|
||||
|
||||
The documentation is written in `reStructuredText (reST) <http://sphinx-doc.org/rest.html>`_,
|
||||
a very easy to write plain text format, relatively similar to Markdown.
|
||||
|
||||
So see what the source looks like, click the **Source** link in the footer of
|
||||
this page.
|
||||
|
||||
Where is the documentation
|
||||
==========================
|
||||
|
||||
The reST documentation files are located in the
|
||||
`converse.js code repository <https://github.com/jcbrand/converse.js/tree/master/docs/source>`_
|
||||
under ``docs/source``.
|
||||
|
||||
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::
|
||||
|
||||
python bootstrap.py
|
||||
./bin/buildout
|
||||
|
||||
Generate the HTML
|
||||
-----------------
|
||||
|
||||
After installing the dependencies, you can generate the HTML by simply
|
||||
running::
|
||||
|
||||
make html
|
||||
|
||||
The HTMl files will be located in ``./docs/html``
|
||||
|
||||
.. warning:: When contributing, please don't commit any generated html files.
|
|
@ -10,6 +10,12 @@ Converse.js Documentation
|
|||
Preface
|
||||
=======
|
||||
|
||||
This is the official documentation for Converse.js. If you'd like to
|
||||
contribute, please read the :doc:`documentation` page.
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
Converse.js is a free and open-source `XMPP <http://xmpp.org/about-xmpp/>`_
|
||||
chat client written in Javascript which can be tightly integrated into any website.
|
||||
|
||||
|
@ -37,4 +43,5 @@ Table of Contents
|
|||
configuration
|
||||
development
|
||||
translations
|
||||
documentation
|
||||
builds
|
||||
|
|
Loading…
Reference in New Issue
Block a user