Skip to content
Snippets Groups Projects
Commit 2a59f01e authored by Bienchen's avatar Bienchen
Browse files

Docu cosmetics, intersphinx integration for Python

parent 57bbb46c
No related branches found
No related tags found
No related merge requests found
...@@ -45,6 +45,7 @@ setup_boost() ...@@ -45,6 +45,7 @@ setup_boost()
find_package(Python 2.7 REQUIRED) find_package(Python 2.7 REQUIRED)
if(NOT DISABLE_DOCUMENTATION) if(NOT DISABLE_DOCUMENTATION)
find_package(Sphinx ${PYTHON_VERSION} REQUIRED) find_package(Sphinx ${PYTHON_VERSION} REQUIRED)
set(PYTHON_DOC_URL "http://docs.python.org/${PYTHON_VERSION}")
endif() endif()
find_package(OPENSTRUCTURE 1.4 REQUIRED find_package(OPENSTRUCTURE 1.4 REQUIRED
COMPONENTS io mol seq seq_alg mol_alg conop) COMPONENTS io mol seq seq_alg mol_alg conop)
......
...@@ -13,7 +13,8 @@ file(MAKE_DIRECTORY ${_RST_SOURCE_DIR}) ...@@ -13,7 +13,8 @@ file(MAKE_DIRECTORY ${_RST_SOURCE_DIR})
set(_SPHINX_CONF_PY "${_RST_SOURCE_DIR}/conf.py") set(_SPHINX_CONF_PY "${_RST_SOURCE_DIR}/conf.py")
set(_SPHINX_CONF_SUBST_DICT PROMOD3_VERSION_MAJOR="${PROMOD3_VERSION_MAJOR}" set(_SPHINX_CONF_SUBST_DICT PROMOD3_VERSION_MAJOR="${PROMOD3_VERSION_MAJOR}"
PROMOD3_VERSION_MINOR="${PROMOD3_VERSION_MINOR}" 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}) set(_CONF_SUBST_DICT -DINPUT_FILE=${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in -DOUT_FILE=${_SPHINX_CONF_PY})
foreach(_subst ${_SPHINX_CONF_SUBST_DICT}) foreach(_subst ${_SPHINX_CONF_SUBST_DICT})
list(APPEND _CONF_SUBST_DICT -D${_subst}) list(APPEND _CONF_SUBST_DICT -D${_subst})
......
...@@ -63,7 +63,7 @@ release = '@PROMOD3_VERSION_PATCH@' ...@@ -63,7 +63,7 @@ release = '@PROMOD3_VERSION_PATCH@'
# non-false value, then it is used: # non-false value, then it is used:
#today = '' #today = ''
# Else, today_fmt is used as the format for a strftime call. # 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 # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
...@@ -127,7 +127,7 @@ html_static_path = list() ...@@ -127,7 +127,7 @@ html_static_path = list()
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # 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 # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
...@@ -246,4 +246,4 @@ texinfo_documents = [ ...@@ -246,4 +246,4 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None} intersphinx_mapping = {'python': ('@PYTHON_DOC_URL@', None)}
...@@ -11,7 +11,9 @@ Contents: ...@@ -11,7 +11,9 @@ Contents:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
meld/index
.. todolist::
Indices and tables Indices and tables
================== ==================
......
...@@ -10,4 +10,4 @@ This module contains functions and classes to model protein structures from sequ ...@@ -10,4 +10,4 @@ This module contains functions and classes to model protein structures from sequ
:maxdepth: 2 :maxdepth: 2
loop loop
rawmodel rawmodel
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment