Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

outoftardis/docs

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
32 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RST Templates for API Documentation

This repository contains templates for API documentation written in reStructuredText (RST).

We are also going to provide auxiliary scripts that might be used to automate some steps of the build process. However, no scripts are avaialable at the moment.

Overview

The guidelines describe which templates to use and in which case. Each project would need a different set of templates depending on whether or not it uses Doxygen, what the structure of the library is, and other project-specific details.

Our goal is to create a similar look-and-feal across API documentation for different libraries and to make it easier for projects to start using Sphinx and reStructuredText markup for their API documentation.

Browse our GitHub Pages to see the output of these templates.

Other Resources

About

API Templates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Morty Proxy This is a proxified and sanitized view of the page, visit original site.