GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - coala/documentation: The official documentation for coala

BranchesTags
Open more actions menu

Latest commit

 

History

261 Commits
261 Commits

Folders and files

NameName
Last commit message
Last commit date
.ci
.ci
 
 
Help
Help
 
 
Users
Users
 
 
_static
_static
 
 
_templates
_templates
 
 
.coafile
.coafile
 
 
.gitignore
.gitignore
 
 
.moban.yaml
.moban.yaml
 
 
.rultor.yml
.rultor.yml
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
PULL_REQUEST_TEMPLATE.md
PULL_REQUEST_TEMPLATE.md
 
 
README.rst
README.rst
 
 
conf.py
conf.py
 
 
docs-requirements.txt
docs-requirements.txt
 
 
index.rst
index.rst
 
 
make.bat
make.bat
 
 
netlify.toml
netlify.toml
 
 
requirements.txt
requirements.txt
 
 
runtime.txt
runtime.txt
 
 

Repository files navigation

https://cloud.githubusercontent.com/assets/5716520/24838296/a9cf5f04-1d45-11e7-855c-47b816ce1e09.png

The official documentation for coala

This is the official documentation for coala, and it is online at https://docs.coala.io. The coala repository can be found here.

How to build

Install virtualenv if you don't have it yet:

pip3 install virtualenvwrapper

Create a new virtualenv and activate it:

virtualenv -p python3 coala-venv
source coala-venv/bin/activate

And then run this command before trying to build the documentation:

pip3 install -r requirements.txt

You can test the documentation locally through simply running

make html

in the root directory. This generates _build/html/index.html that you can view on your browser.

If you want to add new pages, you need to alter the index.rst file in the root directory. Please read http://www.sphinx-doc.org/en/stable/markup/toctree.html#toctree-directive for an explanation of the syntax.

About

The official documentation for coala

docs.coala.io/

Topics

sphinx-documentationuser-documentation

Resources

Readme
AGPL-3.0 license
Activity
Custom properties

Stars

40 stars

Watchers

9 watching

Forks

171 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.