Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-30015: Update Sphinx conf.py for documenteer 0.6 #89

Merged
merged 3 commits into from
Dec 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 0 additions & 3 deletions README.md

This file was deleted.

13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
########
obs_cfht
########

``obs_cfht`` is a package in the `LSST Science Pipelines <https://pipelines.lsst.io>`_.

This package provides CFHT/MegaCam-specific configurations and tasks.
Documentation is available at https://pipelines.lsst.io/modules/lsst.obs.cfht/index.html.

Notes
=====

MegaCam uses the pixel scale 0.185 arcsec/pixel from http://arxiv.org/pdf/0908.3808v1.pdf.
16 changes: 8 additions & 8 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
"""Sphinx configuration file for an LSST stack package.

This configuration only affects single-package Sphinx documenation builds.
This configuration only affects single-package Sphinx documentation builds.
For more information, see:
https://developer.lsst.io/stack/building-single-package-docs.html
"""

from documenteer.sphinxconfig.stackconf import build_package_configs
import lsst.obs.cfht
from documenteer.conf.pipelinespkg import *


_g = globals()
_g.update(build_package_configs(
project_name='obs_cfht',
version=lsst.obs.cfht.version.__version__))
project = "obs_cfht"
html_theme_options["logotext"] = project
html_title = project
html_short_title = project
8 changes: 6 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@ max-line-length = 110
max-doc-length = 79
ignore = E133, E226, E228, N802, N803, N806, N812, N815, N816, W503
exclude =
__init__.py,
config/*
megacam/camera/camera.py
megacam/camera/camera.py,
bin,
doc/conf.py,
**/*/__init__.py,
**/*/version.py,
tests/.tests


[tool:pytest]
Expand Down