# sphinx

**Repository Path**: gricks/sphinx

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-07-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Install
```bash
cd docs
pip install -r requirements.txt

# create doc
sphinx-quickstart 
```

modify conf.py
```python
html_theme = 'sphinx_rtd_theme'
html_theme_path = ["_themes", ]

extensions = [
    'sphinx.ext.intersphinx',
    'sphinx.ext.autodoc',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
    'sphinxcontrib.httpdomain',
    'sphinx_rtd_theme',
    'recommonmark',
]

source_suffix = ['.rst', '.md']

# A dictionary with options for the search language support, empty by default.
html_search_language = 'zh'
html_search_options = {'dict': '/usr/lib/python2.7/site-packages/jieba/dict.txt'}
```

# Build
```
make html
```

# Preview
```
make preview
```

more [https://github.com/readthedocs/sphinx_rtd_theme/](https://github.com/readthedocs/sphinx_rtd_theme/)