Documentation for Megam

Sphinx based documentation that gets built/hosted in www.gomegam.com/docs.

Requirements

Sphinx Ubuntu 14.04 +

Setting up Spinx

sudo apt-get install python-sphinx python-pip

sudo pip install sphinx_bootstrap_theme

Contribte to docs, Fork this repo, send us a Pull request

Sphinx markup reference

Building docs

  • It so simple.

make clean


make html

Open a browser and launch build/index.html to test it.
  • Before you send the pull request, make sure you run make clean

We are glad to help if you have questions, or request for new features..

twitter email

License

Author: Rajthilak (rajthilak@megam.co.in)
Varadarajan Narayanan(rad@megam.co.in)
KishorekumarNeelamegam (nkishore@megam.co.in)
Thomas Alrin(alrin@megam.co.in)
Copyright: Copyright (c) 2013-2014 Megam Systems.
License: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Share this project:
×

Updates