From cf74f58d872b4399301a36b422950f5cda28f52b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Garc=C3=ADa?= Date: Tue, 4 Dec 2018 12:31:13 -0300 Subject: [PATCH] reestructuracion del makefile para docs --- Makefile | 15 +++++++++++++++ docs/css/extra_rtd.css | 12 ++++++++++++ mkdocs.yml | 18 ++++++++++++++++-- requirements-docs.txt | 2 ++ 4 files changed, 45 insertions(+), 2 deletions(-) create mode 100644 docs/css/extra_rtd.css create mode 100644 requirements-docs.txt diff --git a/Makefile b/Makefile index 633dcab..c4d2e8e 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,19 @@ +SHELL = bash + +.PHONY: docs servedocs doctoc + +servedocs: + mkdocs serve + +mkdocsdocs: + mkdocs build + rsync -vau --remove-source-files site/ docs/ + rm -rf site + +docs: doctoc mkdocsdocs + doctoc: ## generate table of contents, doctoc command line tool required ## https://github.com/thlorenz/doctoc doctoc --maxlevel 4 --github --title "## Indice" docs/ find docs/ -name "*.md" -exec bash fix_github_links.sh {} \; + diff --git a/docs/css/extra_rtd.css b/docs/css/extra_rtd.css new file mode 100644 index 0000000..b1c8a36 --- /dev/null +++ b/docs/css/extra_rtd.css @@ -0,0 +1,12 @@ +table { + text-align: center; + margin: 0 auto; +} + +tbody { + display: inline; +} + +.wy-nav-top { + background: rgb(0, 0, 185); +} diff --git a/mkdocs.yml b/mkdocs.yml index bdcfbfd..470baa3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,12 @@ site_name: Portal Andino -pages: +site_author: Datos Argentina +site_description: Documentación de Portal Andino, la distribución de CKAN desarrollada por la República Argentina dockerizada, fácil de instalar y compatible con el Perfil Nacional de Metadatos de la Política de Apertura de Datos. +repo_url: https://github.com/datosgobar/portal-andino/ + +nav: - Inicio: 'index.md' - Comienzo rápido: 'quickstart.md' - # - Manual de uso: 'usage.md' + - Manual de uso: 'usage.md' - Desarrollo: - Instalación: 'developers/install.md' - Actualización: 'developers/update.md' @@ -12,5 +16,15 @@ pages: - Configuración HTTPS: 'developers/https.md' - Configuración de DNS: 'developers/dns.md' - Generación de imágenes Docker: 'developers/docker.md' + - Desarrollo: 'developers/development.md' - Tests: 'developers/tests.md' +theme: datosgobar_docs + +markdown_extensions: [fenced_code, codehilite, admonition] + +extra_css: + - css/extra_rtd.css + +google_analytics: ['UA-91435482-1', "https://portal-andino.readthedocs.io/"] + diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 0000000..5814e70 --- /dev/null +++ b/requirements-docs.txt @@ -0,0 +1,2 @@ +mkdocs<1.1 +mkdocs-datosgobar