Editing CompuCell3D manuals

To contribute to e.g. python scripting manual you need to:

Set up your GitHub account at www.github.com
Clone appropriate github repository with CC3D documentation. For example when editing Python Scripting Manual you woudl do the following:

    mkdir PYTHON_MANUAL
    cd PYTHON_MANUAL
    git clone https://github.com/maciekswat/PythonScriptingManual.git .

in the PYTHON_MANUAL directory all documentation is stored in the form of reStructured Text Format (.rst extension) and located in PYTHON_MANUAL/docs. Strictly speaking we are using Sphinx package so it is a good idea to get familiar with Sphinx documentation. Each chapter is stored as a separate file. The index.rst file is a master file where all chapters that we include int he manual have to be listed (they are names of .rst files without .rst extension). You may either edit existing .rst file (in which case you do not need to alter the content of the index.rst file) or add new file (and in this case you need to add appropriate reference to the index.rst file to include you\r file in the documentation)
The images are stored in the docs/images subfolder of PYTHON_MANUAL
After you are done with your edits you need to commit and push your edits and issue a pull-request on github. Here is a complete guide how to do the pull request
Here is help on Restructured Text Syntax. Sometimes you can figure out formatting tags/markup by reading existing .rst file in our documentation and we encourage you to do so. When you want to format code-snippets this part of Sphinx documentation may be useful
If you need to edit formulas thisLaTeX online equation editor can be quite handy along with Sphinx math documentation

Home