Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the user manual #1

Open
5 tasks
jcbrand opened this issue Dec 19, 2018 · 5 comments
Open
5 tasks

Update the user manual #1

jcbrand opened this issue Dec 19, 2018 · 5 comments

Comments

@jcbrand
Copy link
Member

jcbrand commented Dec 19, 2018

Original ticket here: conversejs/converse.js#1383

The user manual is very old and incomplete.

Tasks for this ticket:

  • Replace all screenshots with modern versions.
  • Also create similar screenshots for Converse in fullscreen view_mode

Expanding the manual with more information (WIP)

  • OMEMO Encryption
  • OMEMO Encryption in a groupchat
  • How to verify OMEMO fingerprints

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
Copy link

@jcbrand Okay understand

@lyabs243
Copy link

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

@jcbrand
Copy link
Member Author

jcbrand commented Dec 19, 2018

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
Copy link

@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
Copy link
Member Author

jcbrand commented Dec 19, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants