From 02c1e653c9667c8d46b14486848db8887d0b2300 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 15 Sep 2020 17:30:38 -0400 Subject: [PATCH 1/3] added docs --- docs/Makefile | 20 ++++++ docs/conf.py | 180 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 17 +++++ 3 files changed, 217 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +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) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..a8915a3 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,180 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Ska.Sun documentation build configuration file, created by +# sphinx-quickstart on Tue May 19 15:46:11 2020. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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('..')) +from Ska.Sun import __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.githubpages', + 'sphinx.ext.mathjax', + 'sphinx.ext.viewcode'] + +# 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' + +# General information about the project. +project = 'Ska.Sun' +copyright = '2020, Tom Aldcroft' +author = 'Tom Aldcroft' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = __version__ +# The full version, including alpha/beta/rc tags. +release = __version__ + +# 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 patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- 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 = 'bootstrap-ska' +html_theme_options = { + 'logotext1': 'Ska! ', # white, semi-bold + 'logotext2': 'Ska', # orange, light + 'logotext3': '.Sun', # white, light + } + +# 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. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +# html_sidebars = { +# '**': [ +# 'about.html', +# 'navigation.html', +# 'relations.html', # needs 'show_related': True theme option to display +# 'searchbox.html', +# 'donate.html', +# ] +# } + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'SkaSundoc' + + +# -- 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, 'SkaSun.tex', 'Ska.Sun Documentation', + 'Tom Aldcroft', '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, 'chandratime', 'Ska.Sun 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, 'SkaSun', 'Ska.Sun Documentation', + author, 'SkaSun', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..4282c29 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +:mod:`Ska.Sun` +====================== + +.. automodule:: Ska.Sun + + +Functions +---------- + +.. autofunction:: position +.. autofunction:: pitch +.. autofunction:: nominal_roll +.. autofunction:: sph_dist + + + + From 84b576daf7989c99deaed599d1f378ba2bf9ecac Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 22 Sep 2020 17:19:36 -0400 Subject: [PATCH 2/3] added link to tool_doc page on cxc --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index a8915a3..2f6dcff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -91,6 +91,9 @@ 'logotext1': 'Ska! ', # white, semi-bold 'logotext2': 'Ska', # orange, light 'logotext3': '.Sun', # white, light + 'homepage_url': 'https://cxc.cfa.harvard.edu/mta/ASPECT/tool_doc', + 'homepage_text': 'ska', + 'homepage_text_2': 'tools' } # Theme options are theme-specific and customize the look and feel of a theme From 526bd6f3e91f2a668d1943f0acc83c54c3f8a130 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 29 Sep 2020 16:23:42 -0400 Subject: [PATCH 3/3] added workflow for docs --- .github/workflows/docs.yml | 49 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..0af5079 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,49 @@ +--- +name: Deploy Docs +on: + release: + types: + - created + repository_dispatch: + types: + - build-docs + +jobs: + build-linux: + runs-on: head + name: Deploy Docs + steps: + - name: Fetch gh-pages + uses: actions/checkout@v2 + with: + path: gh-pages + ref: gh-pages + - name: Fetch source + uses: actions/checkout@v2 + with: + path: source + - name: clear + run: rm -fr gh-pages/docs/* + - name: build + run: | + eval "$(/export/jgonzale/github-workflows/miniconda3-shiny/bin/conda shell.bash hook)" + conda activate ska3-masters + mkdir -p _static + make html + working-directory: source/docs + env: + PYTHONPATH: ${{ github.workspace }}/source + GITHUB_API_TOKEN: ${{ secrets.CHANDRA_XRAY_TOKEN }} + - name: copy + run: cp -fr source/docs/_build/html/* gh-pages/docs + - name: Commit changes + uses: EndBug/add-and-commit@v4 + with: + ref: "gh-pages" + cwd: "gh-pages" + author_name: Javier Gonzalez + author_email: javierggt@yahoo.com + message: "Deploy docs" + add: "docs" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}