-
-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use nbsite to generate documentation website (#247)
Note about a side effect of this change: param conda packages previously appeared on pyviz/label/dev for master, but will now only appear for explicitly dev tags (in line with pyviz convention).
- Loading branch information
Showing
12 changed files
with
424 additions
and
413 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +0,0 @@ | ||
[submodule "doc/builder"] | ||
path = doc/builder | ||
url = https://github.com/ioam/ioam-builder.git | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
Submodule builder
deleted from
fbcf22
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1,39 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
import sys, os | ||
sys.path.append(os.path.dirname(os.path.abspath(__file__))) | ||
from nbsite.shared_conf import * | ||
|
||
from builder.shared_conf import * # pyflakes:ignore (API import) | ||
|
||
paths = ['.', '..'] | ||
add_paths(paths) | ||
|
||
# General information about the project. | ||
project = u'Param' | ||
copyright = u'\u00a9 2003-2018, IOAM' | ||
ioam_project = 'param' | ||
from param import __version__ | ||
|
||
|
||
# The version info for the project being documented, defining |version| | ||
# and |release| and used in various other places throughout the built | ||
# documents. Assumes __version__ is a param.version.Version object. | ||
# | ||
# The short X.Y.Z version. | ||
version = __version__.abbrev() | ||
|
||
# The full version, including alpha/beta/rc/dev tags. | ||
release = __version__.abbrev(dev_suffix="-dev") | ||
|
||
|
||
# List of patterns, relative to source directory, that match files and | ||
# directories to ignore when looking for source files. | ||
exclude_patterns = ['_build'] | ||
|
||
# Add any paths that contain custom static files (such as style sheets) here, | ||
# relative to this directory. They are copied after the builtin static files, | ||
# so a file named "default.css" will overwrite the builtin "default.css". | ||
html_static_path = ['_static', 'builder/_shared_static'] | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = project + 'doc' | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, | ||
# author, documentclass [howto, manual, or own class]). | ||
latex_documents = [ | ||
('index', project+'.tex', project + ' Documentation', | ||
u'IOAM', 'manual'), | ||
] | ||
|
||
# -- Options for manual page output --------------------------------------- | ||
|
||
# One entry per manual page. List of tuples | ||
# (source start file, name, description, authors, manual section). | ||
man_pages = [ | ||
('index', ioam_project, project + ' Documentation', | ||
[u'IOAM'], 1) | ||
] | ||
|
||
# If true, show URL addresses after external links. | ||
#man_show_urls = False | ||
|
||
# -- Options for Texinfo output ------------------------------------------- | ||
|
||
# Grouping the document tree into Texinfo files. List of tuples | ||
# (source start file, target name, title, author, | ||
# dir menu entry, description, category) | ||
texinfo_documents = [ | ||
('index', project, project + ' Documentation', | ||
u'IOAM', project, 'One line description of project.', | ||
'Miscellaneous'), | ||
] | ||
|
||
# Example configuration for intersphinx: refer to the Python standard library. | ||
intersphinx_mapping = {'http://docs.python.org/': None} | ||
authors = u'PyViz authors' | ||
copyright = u'\u00a9 2005-2018, ' + authors | ||
description = 'Declarative Python programming using Parameters.' | ||
|
||
import param | ||
version = release = param.__version__ | ||
|
||
html_static_path += ['_static'] | ||
html_theme = 'sphinx_ioam_theme' | ||
html_theme_options = { | ||
'logo':'logo.png', | ||
'favicon':'favicon.ico', | ||
# 'css':'site.css' | ||
} | ||
|
||
_NAV = ( | ||
('API', 'Reference_Manual/param'), | ||
('About', 'About'), | ||
) | ||
|
||
html_context.update({ | ||
'PROJECT': project, | ||
'DESCRIPTION': description, | ||
'AUTHOR': authors, | ||
# canonical URL (for search engines); can ignore for local builds | ||
'WEBSITE_SERVER': 'https://param.pyviz.org', | ||
'VERSION': version, | ||
'NAV': _NAV, | ||
'LINKS': _NAV, | ||
'SOCIAL': ( | ||
('Gitter', '//gitter.im/ioam/holoviews'), | ||
('Github', '//github.com/ioam/param'), | ||
) | ||
}) |
Oops, something went wrong.