Browse Source

Merge branch 'feature/docs-site-theme' into develop

default_compile_flags
vector-of-bool 4 years ago
parent
commit
949ad60322
4 changed files with 40 additions and 8 deletions
  1. +3
    -0
      Makefile
  2. +7
    -1
      docs/conf.py
  3. +0
    -7
      docs/index.rst
  4. +30
    -0
      docs/layout.html

+ 3
- 0
Makefile View File

-Wqanj8 -Wqanj8
echo "Docs generated to _build/docs" echo "Docs generated to _build/docs"


hugo-docs:
env GEN_FOR_HUGO=1 $(MAKE) docs

docs-server: docs docs-server: docs
echo "Docs are visible on http://localhost:9794/" echo "Docs are visible on http://localhost:9794/"
cd _build/docs && \ cd _build/docs && \

+ 7
- 1
docs/conf.py View File

# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Refer: http://www.sphinx-doc.org/en/master/config # Refer: http://www.sphinx-doc.org/en/master/config


import os

# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'dds' project = 'dds'
copyright = '2020, vector-of-bool' copyright = '2020, vector-of-bool'


# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
extensions = [] extensions = []
templates_path = ['_templates']
templates_path = []
source_suffix = '.rst' source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
language = None language = None
html_theme_options = {} html_theme_options = {}
html_static_path = [] html_static_path = []
html_sidebars = {} html_sidebars = {}

if os.environ.get('GEN_FOR_HUGO'):
templates_path.append('.')
html_theme = 'basic'

+ 0
- 7
docs/index.rst View File

design design
dev/index dev/index
err/index err/index

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

+ 30
- 0
docs/layout.html View File

---
title: "{{ title | striptags }}"
layout: single
{% if not pagename.endswith('index') -%}
url: docs/{{pagename}}{{file_suffix}}
{%- endif %}
---

<div class="toc global" open>
<div class="toc-content" role="navigation" aria-label="global navigation">
<div class="toc-header">Contents</div>
{{ toctree(maxdepth=5, titles_only=True) }}
</div>
</div>

<div class="toc local" open>
<div class="toc-content" role="navigation" aria-label="local navigation">
<div class="toc-header">On this page</div>
{{ toc }}
</div>
</div>

<div class="page-content">
{{ body }}
{% if next %}
<div class="next-link">
Next: <a href="{{ next.link }}">{{ next.title }}</a>
</div>
{% endif %}
</div>

Loading…
Cancel
Save