Skip to content

Commit

Permalink
Merge 739aa5b into 7a5a01b
Browse files Browse the repository at this point in the history
  • Loading branch information
drdavella committed Jun 28, 2019
2 parents 7a5a01b + 739aa5b commit 4fdfa22
Show file tree
Hide file tree
Showing 21 changed files with 46 additions and 1,462 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -20,6 +20,7 @@ MANIFEST
# Sphinx
docs/api
docs/_build
docs/generated

# Eclipse editor project files
.project
Expand Down
1 change: 1 addition & 0 deletions .rtd-environment.yml
Expand Up @@ -9,4 +9,5 @@ dependencies:
- stsci_rtd_theme
- asdf
- sphinx_rtd_theme
- sphinx-asdf

2 changes: 2 additions & 0 deletions .travis.yml
Expand Up @@ -48,6 +48,7 @@ matrix:
# Check for sphinx doc build warnings - we do this first because it
# may run for a long time
- python: 3.6

env: PIP_DEPENDENCIES='.[docs]'
SETUP_CMD='build_docs -w'

Expand Down Expand Up @@ -94,6 +95,7 @@ matrix:
install:
- git clone git://github.com/astropy/ci-helpers.git
- source ci-helpers/travis/setup_conda.sh
- pip install .

script:
- $MAIN_CMD $SETUP_CMD
Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Expand Up @@ -5,6 +5,7 @@ include ah_bootstrap.py
include setup.cfg

recursive-include docs *
exclude docs/generated
recursive-include licenses *
recursive-include cextern *
recursive-include scripts *
Expand Down
45 changes: 21 additions & 24 deletions docs/conf.py
Expand Up @@ -30,23 +30,18 @@
import sys

try:
import astropy_helpers
from sphinx_astropy.conf.v1 import * # noqa
except ImportError:
# Building from inside the docs/ directory?
if os.path.basename(os.getcwd()) == 'docs':
a_h_path = os.path.abspath(os.path.join('..', 'astropy_helpers'))
if os.path.isdir(a_h_path):
sys.path.insert(1, a_h_path)

# Load all of the global Astropy configuration
from astropy_helpers.sphinx.conf import *
print('ERROR: the documentation requires the sphinx-astropy package to be installed')
sys.exit(1)

# Get configuration information from setup.cfg
try:
from ConfigParser import ConfigParser
except ImportError:
from configparser import ConfigParser
conf = ConfigParser()

conf.read([os.path.join(os.path.dirname(__file__), '..', 'setup.cfg')])
setup_cfg = dict(conf.items('metadata'))

Expand All @@ -68,6 +63,15 @@
rst_epilog += """
"""

# Top-level directory containing ASDF schemas (relative to current directory)
asdf_schema_path = '../gwcs/schemas'
# This is the prefix common to all schema IDs in this repository
asdf_schema_standard_prefix = 'stsci.edu/gwcs'
asdf_schema_reference_mappings = [
('tag:stsci.edu:asdf',
'http://asdf-standard.readthedocs.io/en/latest/generated/stsci.edu/asdf/'),
]

# -- Project information ------------------------------------------------------

# This does not *have* to match the package name, but typically does
Expand All @@ -80,14 +84,10 @@
# |version| and |release|, also used in various other places throughout the
# built documents.

__import__(setup_cfg['name'])
package = sys.modules[setup_cfg['name']]

# The short X.Y version.
version = package.__version__.split('-', 1)[0]
# The full version, including alpha/beta/rc tags.
release = package.__version__

from pkg_resources import get_distribution
release = get_distribution(project).version
# for example take major/minor
version = '.'.join(release.split('.')[:2])

# -- Options for HTML output ---------------------------------------------------

Expand All @@ -107,13 +107,13 @@
# name of a builtin theme or the name of a custom theme in html_theme_path.
#html_theme = None


# Please update these texts to match the name of your package.
# See sphinx-bootstrap-theme for documentation of these options
# https://github.com/ryan-roemer/sphinx-bootstrap-theme
html_theme_options = {
'logotext1': 'g', # white, semi-bold
'logotext2': 'wcs', # orange, light
'logotext3': ':docs' # white, light
}
}


# Custom sidebar templates, maps document names to template names.
Expand Down Expand Up @@ -151,7 +151,6 @@
man_pages = [('index', project.lower(), project + u' Documentation',
[author], 1)]


## -- Options for the edit_on_github extension ----------------------------------------

if eval(setup_cfg.get('edit_on_github')):
Expand All @@ -167,7 +166,5 @@
edit_on_github_source_root = ""
edit_on_github_doc_root = "docs"


sys.path.insert(0, os.path.join(os.path.dirname('__file__'), 'sphinxext'))
extensions += ['category']

extensions += ['sphinx_asdf']
78 changes: 0 additions & 78 deletions docs/gwcs/schemas/celestial_frame-1.0.0.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/gwcs/schemas/composite_frame-1.0.0.rst

This file was deleted.

0 comments on commit 4fdfa22

Please sign in to comment.