Skip to content

sswaroopgupta/docs.gauge.org

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

User Documentation for Gauge

Contributor Covenant

This is the repository for Gauge documentation.

The documents are written in RST and are built using Sphinx, a theme based on readthedocs.

Conventions

  • Every released version is maintained in a separate branch.
  • Every build will generate docs for all versions maintained.
  • The root documentation points to the latest released verion. Navigate to master version for the development version of this documentation.

Pre-requisites

  • Python 3

Building the documentation

There are two formats of documentation built for every version.

  • pip3 install -r requirements.txt to install the pre-requisites for docs.gauge.org

  • make local-build will build html documentation. The output is available in _build directory.

  • make serve will invoke zip and bring a local http server. http://localhost:8000 will serve this documentation.

Running accessibility test

The accessibility test are writen using jest, taiko and taiko-accessibility plugin.

Run tests

Run the following command to run the tests:

make test

About

User documentation for Gauge

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 51.2%
  • HTML 16.3%
  • JavaScript 15.6%
  • Python 14.9%
  • Makefile 1.6%
  • Shell 0.4%