-
Notifications
You must be signed in to change notification settings - Fork 0
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
Comments
3 tasks
@jcbrand Okay understand |
@jcbrand 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 |
@jcbrand i have the following error when i try to build
|
@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
Original ticket here: conversejs/converse.js#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
The text was updated successfully, but these errors were encountered: