https://github.com/fhightower/test-the-docs

Simple testing suite for docs hosted on ReadTheDocs.
https://github.com/fhightower/test-the-docs

documentation readthedocs testing testing-framework testthedocs

Last synced: 9 months ago
JSON representation

Simple testing suite for docs hosted on ReadTheDocs.

• Host: GitHub
• URL: https://github.com/fhightower/test-the-docs
• Owner: fhightower
• License: mit
• Created: 2017-05-10T20:34:48.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-01T21:54:58.000Z (about 9 years ago)
• Last Synced: 2025-09-22T22:55:13.475Z (9 months ago)
• Topics: documentation, readthedocs, testing, testing-framework, testthedocs
• Language: Python
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Test the Docs!

[![Build Status](https://travis-ci.org/fhightower/test-the-docs.svg?branch=master)](https://travis-ci.org/fhightower/test-the-docs)

[![Documentation Status](https://readthedocs.org/projects/test-the-docs/badge/?version=latest)](http://test-the-docs.readthedocs.io/en/latest/?badge=latest)

Yes, **^** this is supposed to be failing (see [Exhibit 0](https://test-the-docs.readthedocs.io/en/latest/examples.html#exhibit-0-failing-code-block)).

This repository provides a testing suite for documentation built with [Read the Docs](https://readthedocs.org/). The goal is to provide a way to test the integrity of both the documentation itself and any code snippets in the documentation.

You can see a live example of this suite being used in the [ThreatConnect developer documentation](https://github.com/ThreatConnect-Inc/ThreatConnect_Developer_Docs/tree/master/tests).