Bladeren bron

Hugo docs are generated differently

default_compile_flags
vector-of-bool 4 jaren geleden
bovenliggende
commit
db5900a3a6
3 gewijzigde bestanden met toevoegingen van 13 en 4 verwijderingen
  1. +3
    -0
      Makefile
  2. +8
    -2
      docs/conf.py
  3. +2
    -2
      docs/layout.html

+ 3
- 0
Makefile Bestand weergeven

@@ -20,6 +20,9 @@ docs:
-Wqanj8
echo "Docs generated to _build/docs"

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

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

+ 8
- 2
docs/conf.py Bestand weergeven

@@ -1,6 +1,8 @@
# -*- coding: utf-8 -*-
# Refer: http://www.sphinx-doc.org/en/master/config

import os

# -- Project information -----------------------------------------------------
project = 'dds'
copyright = '2020, vector-of-bool'
@@ -13,7 +15,7 @@ release = '0.1.0-alpha.4'

# -- General configuration ---------------------------------------------------
extensions = []
templates_path = ['.']
templates_path = []
source_suffix = '.rst'
master_doc = 'index'
language = None
@@ -21,7 +23,11 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
pygments_style = None

# -- Options for HTML output -------------------------------------------------
html_theme = 'basic'
html_theme = 'nature'
html_theme_options = {}
html_static_path = []
html_sidebars = {}

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

+ 2
- 2
docs/layout.html Bestand weergeven

@@ -6,14 +6,14 @@ url: docs/{{pagename}}{{file_suffix}}
{%- endif %}
---

<div class="toc global">
<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">
<div class="toc local" open>
<div class="toc-content" role="navigation" aria-label="local navigation">
<div class="toc-header">On this page</div>
{{ toc }}

Laden…
Annuleren
Opslaan