Coder Social home page Coder Social logo

user-manual's Introduction

The Converse user manual

This repo contains the Sphinx source files for the user manual of Converse.

The user manual was originally inside the converse.js repo, but has been moved here with git filter-branch.

How to generate HTML from the source files?

Generate the HTML

You can generate the HTML by running:

make html

The HTMl files will be located in ./html

Behind the scenes, what the make html command is doing, is to install zc.buildout and then using that to install Sphinx and its dependencies.

You'll need to have Python and Virtualenv available on your computer.

Serving the documentation

To view the generated docs, you can run make serve and then open http://localhost:8001/docs/html/index.html in your browser.

License

The user manual documentation is released under the Creative Commons license CC BY-SA 4.0.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.