# rest_doc

**Repository Path**: ulysses-s/rest_doc

## Basic Information

- **Project Name**: rest_doc
- **Description**: REST documentation based on sphinx
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-12-01
- **Last Updated**: 2025-12-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RESTdoc repository

## How to contribute

* Write your awesome documentation in Markdown file under `source/user`, such as `dft.md`, for the usage of certain feature. Add a new file if needed.
* Write chinese version in `source_zh`. Write in only one language is ok, just left another language version as "to be added".
* Write corresponding Markdown file in `source/contributor`, if needed, for code structure, brief API doc, etc.
* run `make multilang` to build the doc. (Need sphinx and dependencies, run `pip install -r requirements.txt` if not installed)
* run `python -m http.server --directory build/html` to serve and visit `localhost:8000` in browser to preview the pages.