Skip to content

Instantly share code, notes, and snippets.

@bccho

bccho/__LOOKATME_make_docset.sh

Last active July 20, 2020 03:40
Show Gist options
  • Save bccho/67742935ad7491e07056518330061c40 to your computer and use it in GitHub Desktop.
Save bccho/67742935ad7491e07056518330061c40 to your computer and use it in GitHub Desktop.
Download ZIP
Make Plotly docset
Raw
__LOOKATME_make_docset.sh
# Tested only with python 2.7 but should work regardless
pip install numpy ipywidgets pandas matplotlib nose mock plotly
pip install sphinx doc2dash
ORIG_DIR=$PWD
cd /path/to/build/directory
git clone https://github.com/plotly/plotly.py plotly
VERSION=$(python -c "exec(open('plotly/version.py').read()); print(__version__)")
mkdir -p plotly/docs
cd plotly/docs
mkdir -p source
mkdir -p source/_static
mkdir -p source/_templates
mkdir -p build
# sphinx-apidoc [options] -o [output dir] [src code dir] [exclude dirs]
sphinx-apidoc --separate --private --force -s rst -o source/ ../plotly/ ../plotly/tests/ ../plotly/validators
cp $ORIG_DIR/dabest_conf.py source/conf.py
cp $ORIG_DIR/dabest_index.rst source/index.rst
cp $ORIG_DIR/dabest_Makefile Makefile
make html
wget https://plot.ly/gh-pages/documentation/static/images/plotly-ico.png
# TODO: need to convert plotly-ico.png to a real PNG (it's actually secretly a .ico file)
# If you want to download imagemagick, you can use
# convert plotly-ico.png icon.png
doc2dash -n Plotly -i icon.png -I index.html build/html
Raw
dabest_conf.py
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
project = u'Plotly'
copyright = u'Plotly'
author = u'Plotly'
# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
exec(open('../../plotly/version.py').read())
release = __version__
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
# 'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinxdoc'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# 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']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'Plotlydoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# 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 = [
(master_doc, 'Plotly.tex', u'Plotly Documentation',
u'Plotly', 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'plotly', u'Plotly Documentation',
[author], 1)
]
# -- 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 = [
(master_doc, 'Plotly', u'Plotly Documentation',
author, 'Plotly', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
napoleon_google_docstring = False
napoleon_use_param = False
napoleon_use_ivar = True
Raw
dabest_index.rst
Raw
dabest_Makefile
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment