From 2a59f01e0377967c547d70f9f81e382a10cabd96 Mon Sep 17 00:00:00 2001
From: Stefan Bienert <stefan.bienert@unibas.ch>
Date: Tue, 29 Oct 2013 14:02:45 +0100
Subject: [PATCH] Docu cosmetics, intersphinx integration for Python
---
CMakeLists.txt | 1 +
doc/CMakeLists.txt | 3 ++-
doc/conf.py.in | 6 +++---
doc/index.rst | 2 ++
meld/doc/index.rst | 2 +-
5 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index f652301f..200c0c86 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -45,6 +45,7 @@ setup_boost()
find_package(Python 2.7 REQUIRED)
if(NOT DISABLE_DOCUMENTATION)
find_package(Sphinx ${PYTHON_VERSION} REQUIRED)
+ set(PYTHON_DOC_URL "http://docs.python.org/${PYTHON_VERSION}")
endif()
find_package(OPENSTRUCTURE 1.4 REQUIRED
COMPONENTS io mol seq seq_alg mol_alg conop)
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index e79c4016..ae64ac2b 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -13,7 +13,8 @@ file(MAKE_DIRECTORY ${_RST_SOURCE_DIR})
set(_SPHINX_CONF_PY "${_RST_SOURCE_DIR}/conf.py")
set(_SPHINX_CONF_SUBST_DICT PROMOD3_VERSION_MAJOR="${PROMOD3_VERSION_MAJOR}"
PROMOD3_VERSION_MINOR="${PROMOD3_VERSION_MINOR}"
- PROMOD3_VERSION_PATCH="${PROMOD3_VERSION_PATCH}")
+ PROMOD3_VERSION_PATCH="${PROMOD3_VERSION_PATCH}"
+ PYTHON_DOC_URL="${PYTHON_DOC_URL}")
set(_CONF_SUBST_DICT -DINPUT_FILE=${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in -DOUT_FILE=${_SPHINX_CONF_PY})
foreach(_subst ${_SPHINX_CONF_SUBST_DICT})
list(APPEND _CONF_SUBST_DICT -D${_subst})
diff --git a/doc/conf.py.in b/doc/conf.py.in
index c6987f79..3d502970 100644
--- a/doc/conf.py.in
+++ b/doc/conf.py.in
@@ -63,7 +63,7 @@ release = '@PROMOD3_VERSION_PATCH@'
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+today_fmt = '%B %d %H:%M, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@@ -127,7 +127,7 @@ html_static_path = list()
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = '%b %d %H:%M, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
@@ -246,4 +246,4 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {'python': ('@PYTHON_DOC_URL@', None)}
diff --git a/doc/index.rst b/doc/index.rst
index b53c71a8..133980cd 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -11,7 +11,9 @@ Contents:
.. toctree::
:maxdepth: 2
+ meld/index
+.. todolist::
Indices and tables
==================
diff --git a/meld/doc/index.rst b/meld/doc/index.rst
index aed0b6b5..fec388e6 100644
--- a/meld/doc/index.rst
+++ b/meld/doc/index.rst
@@ -10,4 +10,4 @@ This module contains functions and classes to model protein structures from sequ
:maxdepth: 2
loop
- rawmodel
\ No newline at end of file
+ rawmodel
--
GitLab