Skip to main content

Sphinx Documentation Build Automation

Project description

Giza is a collection of tools built around Sphinx, that coordinates assembling, building, and deploying documentation. Giza primarily addresses the MongoDB documentation project; however, its design is sufficiently generic to be able to facilitate the builds of multiple documentation resources produced at MongoDB.

Resources

Giza on PyPi

Giza on Github

File issues in the MongoDB DOCS Jira Project.

Installation

Giza is available in PyPi, and all dependencies and the package handles all dependencies and version management. For most use, you will want to install Giza using the specification in the requirements.txt file in the repository and branch you want to build. Use the following command:

pip install -r requirements.txt

While most branches will use the latest version of the software, at some point in the future, it may only be possible to build some older branches with a specific version of Giza. Using requirements.txt ensure that you will always install the correct version of Giza.

At any time, you can install the latest version with the following pip command:

pip install giza

To install the optional github and jira integration, use the following command:

pip install giza [jira,github]

Additional Components

Beyond the giza command, the Giza package includes several additional utilities that address various needs of the documentation project:

scrumpy provides reports that help us manage our SCRUM and sprint, as well as help with Jira triage and backlog management.

mdbpr is a tool that integrates with Github to identify pull requests that appropriate for merging.

These components are simple but contain additional dependencies and do not share the same root configuration structure with regards to the main giza application. Furthermore, their functionality is not likely to be relevant for a majority of Giza users.

Project details


Release history Release notifications

History Node

0.5.17

History Node

0.5.16

History Node

0.5.15

History Node

0.5.14

History Node

0.5.13

History Node

0.5.12

History Node

0.5.11

History Node

0.5.10

History Node

0.5.9

History Node

0.5.8

History Node

0.5.6

History Node

0.5.5

History Node

0.5.4

History Node

0.5.3

History Node

0.5.2

History Node

0.5.1

History Node

0.5.0

History Node

0.4.8

History Node

0.4.7

History Node

0.4.6

History Node

0.4.6b2

History Node

0.4.6b1

History Node

0.4.5

History Node

0.4.4

History Node

0.4.3

History Node

0.4.3rc2.dev0

History Node

0.4.3rc1

History Node

0.4.3rc0

History Node

0.4.2

History Node

0.4.2-pre0

History Node

0.4.2a3

History Node

0.4.2a2

History Node

0.4.2a1

History Node

0.4.1

History Node

0.4.1-rc2

History Node

0.4.1-rc1

History Node

0.4.1-rc0

History Node

0.4.1-beta4

History Node

0.4.1-beta3

History Node

0.4.1-beta2

History Node

0.4.1-beta1

History Node

0.4.1-beta0

History Node

0.4.0

History Node

0.4.0-rc9

History Node

0.4.0-rc8

History Node

0.4.0-rc7

History Node

0.4.0-rc6

History Node

0.4.0-rc5

History Node

0.4.0-rc4

History Node

0.4.0-rc3

History Node

0.4.0-rc2

History Node

0.4.0-rc1

History Node

0.4.0-rc0

History Node

0.4.0-beta6

History Node

0.4.0-beta5

History Node

0.4.0-beta4

History Node

0.4.0-beta3

History Node

0.4.0-beta2

History Node

0.4.0-beta1

History Node

0.4.0-beta0

History Node

0.3.9

History Node

0.3.9-beta3

History Node

0.3.9-beta2

History Node

0.3.9-beta1

History Node

0.3.9-beta0

History Node

0.3.8

History Node

0.3.7

History Node

0.3.6

History Node

0.3.5

History Node

0.3.4

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.9

History Node

0.2.8

History Node

0.2.7

This version
History Node

0.2.6

History Node

0.2.5

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
giza-0.2.6.tar.gz (93.2 kB) Copy SHA256 hash SHA256 Source None Aug 27, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page