From 8831548868eb402f497cfff87b67b026298e72ce Mon Sep 17 00:00:00 2001 From: "LAPTOP-MB0HU4QI\\Mostapha" Date: Wed, 13 Mar 2019 21:31:52 -0400 Subject: [PATCH 1/3] docs(sphinx): added docs folder and conf.py This commit adds documentation settings for sphinx. You need to install libraries below to be able to run the documentation locally: - Sphinx - sphinxcontrib-fulltoc - sphinx_bootstrap_theme Here are the commands to generate the documentation locally from root folder. This commands will be set in .travis.yml file to automate the documentation. ```python pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug ./ladybug/euclid.py sphinx-build -b html ./docs ./docs/_build/html ``` --- docs/_build/README.md | 1 + docs/conf.py | 214 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 21 +++++ docs/modules.rst | 7 ++ 4 files changed, 243 insertions(+) create mode 100644 docs/_build/README.md create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/modules.rst diff --git a/docs/_build/README.md b/docs/_build/README.md new file mode 100644 index 00000000..551d1290 --- /dev/null +++ b/docs/_build/README.md @@ -0,0 +1 @@ +# place holder for documentation diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..fc97500f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,214 @@ +# -*- 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 = 'ladybug' +copyright = '2019, Ladybug Tools' +author = 'Ladybug Tools' + +# The short X.Y version +version = '0.2.0' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- 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.doctest', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.imgmath', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', + 'sphinxcontrib.fulltoc', + '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. +# +import sphinx_bootstrap_theme + +# html_theme = 'alabaster' +html_theme = 'bootstrap' +html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() + +# 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 = { + # For black navbar, do "navbar navbar-inverse" + 'navbar_class': "navbar navbar-inverse", + # Fix navigation bar to top of page? + # Values: "true" (default) or "false" + 'navbar_fixed_top': "true", + 'navbar_pagenav': True, + 'source_link_position': "nav", + 'bootswatch_theme': "united", + 'bootstrap_version': "3", + } + +# on_rtd is whether we are on readthedocs.org +# on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +# if not on_rtd: # only import and set the theme if we're building docs locally +# import sphinx_rtd_theme +# html_theme = 'sphinx_rtd_theme' +# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# 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 = { + '**': ['localtoc.html'] +} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ladybugdoc' + + +# -- 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, 'ladybug.tex', 'ladybug Documentation', + 'Ladybug Tools', '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, 'ladybug', 'ladybug 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, 'ladybug', 'ladybug Documentation', + author, 'ladybug', '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 ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..cc861edf --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +.. Ladybug documentation master file, created by + sphinx-quickstart on Wed Mar 13 20:09:41 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Ladybug's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +.. include:: modules.rst + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 00000000..dc062de9 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +ladybug +======= + +.. toctree:: + :maxdepth: 4 + + ladybug From 32b8c8b7b3900a9c6339cee3c149a4f8096a299f Mon Sep 17 00:00:00 2001 From: "LAPTOP-MB0HU4QI\\Mostapha" Date: Wed, 13 Mar 2019 22:22:42 -0400 Subject: [PATCH 2/3] docs(travis): Added documentation deployment to travis --- .travis.yml | 13 +++++++++++++ docs/_build/docs/README.md | 1 + docs/conf.py | 4 +++- 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/_build/docs/README.md diff --git a/.travis.yml b/.travis.yml index dfb8b095..fca3b19d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -26,3 +26,16 @@ jobs: - git config --global user.email "release@ladybug.tools" - pip install python-semantic-release - semantic-release publish + # generate updated documentation + - pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme + - sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug ./ladybug/euclid.py + - sphinx-build -b html ./docs ./docs/_build/docs + # deploy to github pages + # https://docs.travis-ci.com/user/deployment/pages/ + provider: pages + skip_cleanup: true + github-token: $GH_TOKEN + keep-history: false + on: + branch: master + local_dir: docs/_build/ \ No newline at end of file diff --git a/docs/_build/docs/README.md b/docs/_build/docs/README.md new file mode 100644 index 00000000..551d1290 --- /dev/null +++ b/docs/_build/docs/README.md @@ -0,0 +1 @@ +# place holder for documentation diff --git a/docs/conf.py b/docs/conf.py index fc97500f..3816b171 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,9 @@ author = 'Ladybug Tools' # The short X.Y version -version = '0.2.0' +import ladybug +version = ladybug.__version__ + # The full version, including alpha/beta/rc tags release = '' From c9bd72c117bb94aa3b9b9569f7b86c3cf066d94c Mon Sep 17 00:00:00 2001 From: Mostapha Sadeghipour Roudsari Date: Fri, 15 Mar 2019 16:20:55 -0400 Subject: [PATCH 3/3] Added instructions for usage --- docs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..31c0ca5e --- /dev/null +++ b/docs/README.md @@ -0,0 +1,14 @@ + +## Usage +For generating the documents localy use commands below from the root folder. + +```shell +# install dependencies +pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme + +# generate rst files for ladybug modules except for euclid +sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug ./ladybug/euclid.py + +# build the documentation under _build/docs folder +sphinx-build -b html ./docs ./docs/_build/docs +```