Skip to content
This repository has been archived by the owner on Jan 12, 2021. It is now read-only.

Commit

Permalink
Merge pull request #241 from dephell/docs-alabaster
Browse files Browse the repository at this point in the history
use alabaster theme for docs
  • Loading branch information
orsinium committed Jul 19, 2019
2 parents 3b42308 + 2537df4 commit e1dd604
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/cmd-docker-shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Run a shell inside of the Docker container for a current project and environment
The command is also useful for quick experiments with project in the isolated environment:

```bash
sudo dephell docker shell --docker-container=tmp
$ sudo dephell docker shell --docker-container=tmp
WARNING creating container... (container=tmp)
INFO openning shell... (container=tmp)
sh: 1: zsh: not found
Expand Down
32 changes: 23 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
from pathlib import Path

# external
import sphinx_rtd_theme
import alabaster
from recommonmark.parser import CommonMarkParser
from recommonmark.transform import AutoStructify


sys.path.append(os.path.abspath('../'))
extensions = [
'alabaster',
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
Expand Down Expand Up @@ -40,17 +41,30 @@
todo_include_todos = True

pygments_style = 'sphinx'
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = str(Path(__file__).parent.parent / 'assets' / 'logo.png')
html_theme = 'alabaster'
html_theme_path = [alabaster.get_path()]
html_static_path = [str(Path(__file__).parent.parent / 'assets')]
html_theme_options = {
'logo_only': True,
'display_version': False,
'style_external_links': True,
'style_nav_header_background': '#2c3e50',
'logo': 'logo.png',
'logo_name': 'false',
'description': 'Python project management',

'sidebar_width': '240px',
'show_powered_by': 'false',
'caption_font_size': '20px',

# 'color': '#2c3e50',
'github_banner': 'true',
'github_user': 'dephell',
'github_repo': 'dephell',
'github_type': 'star',

'extra_nav_links': {
'GitHub repository': 'https://github.com/dephell/dephell',
'Create an issue': 'https://github.com/dephell/dephell/issues/new',
},
}


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,9 @@ pytest = "*"
requests-mock = "*"
aioresponses = "*"

alabaster = "*"
sphinx = "*"
recommonmark = "*"
sphinx-rtd-theme = "*"
pygments-github-lexers = "*"

flake8-isort = "*"
Expand All @@ -188,4 +188,4 @@ isort = {extras = ["pyproject"],version = "*"}
[tool.poetry.extras]
full = ["aiofiles", "autopep8", "colorama", "graphviz", "yapf"]
tests = ["aioresponses", "pytest", "requests-mock"]
docs = ["pygments-github-lexers", "recommonmark", "sphinx", "sphinx-rtd-theme"]
docs = ["pygments-github-lexers", "recommonmark", "sphinx", "alabaster"]

0 comments on commit e1dd604

Please sign in to comment.