search

conversejs / user-manual

The user manual for Converse
1 stars 0 forks source link

Update the user manual #1

Open jcbrand opened 5 years ago

jcbrand commented 5 years ago

Original ticket here: https://github.com/conversejs/converse.js/issues/1383

The user manual is very old and incomplete.

Tasks for this ticket:

Expanding the manual with more information (WIP)

Technical information

The user manual is in It's in ./docs/source/manual.rst in the Converse repo. See: https://github.com/conversejs/converse.js/blob/master/docs/source/manual.rst

The manual is written in RestructuredText and generated with Sphinx

Sphinx uses Python, so you'll need to set up a Python virtual environment with Buildout to manage dependencies.

Follow the instructions here: https://github.com/conversejs/converse.js/blob/master/docs/source/documentation.rst

lyabs243 commented 5 years ago

@jcbrand Okay understand

lyabs243 commented 5 years ago

@jcbrand is it necessary to use "sphinx-quickstart" to update an existing sphinx reStructuredText?

jcbrand commented 5 years ago

is it necessary to use "sphinx-quickstart" to update an existing sphinx reStructuredText?

No, it's not necessary.

YOu can just edit the index.rst file and then run make html.

lyabs243 commented 5 years ago

@jcbrand i have the following error when i try to build

There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "c:\users\lyabs\appdata\local\programs\python\python37\lib\site-packages\sphinx\config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "c:\users\lyabs\appdata\local\programs\python\python37\lib\site-packages\sphinx\util\pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "C:\wamp\www\user-manual\source\conf.py", line 94, in <module>
    import sphinx_bootstrap_theme
jcbrand commented 5 years ago

@lyabs243: Let's discuss this in the chatroom.