https://github.com/arashem/doc-template

template for documentation based on sphinx
https://github.com/arashem/doc-template

Last synced: 3 months ago
JSON representation

template for documentation based on sphinx

• Host: GitHub
• URL: https://github.com/arashem/doc-template
• Owner: ArashEM
• Created: 2020-06-04T06:54:29.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-05T14:50:29.000Z (almost 5 years ago)
• Last Synced: 2025-01-14T08:52:27.483Z (4 months ago)
• Language: Dockerfile
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Documentation Template

![Docker Pulls](https://img.shields.io/docker/pulls/arash7/sphinx-html?style=flat-square)

This repository contain based system for developing/compiling document based on `rst` and `sphinx`.

## Dependencies

* Sphinx

* sphinx\_rtd\_theme

###  Install build dependencies on Debian

``` bash

sudo apt-get install python-pip plantuml sphinx

sudo pip install sphinx_rtd_theme

```

## Building

``` bash

    cd docs/

    make html

```

You can find html files in `docs/build/html`