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 #173

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
8 changes: 8 additions & 0 deletions README.rst
@@ -0,0 +1,8 @@
#########
meas_base
#########

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

The ``lsst.meas.base`` Python module provides core astronomical measurement algorithms and base classes.
Documentation is available at https://pipelines.lsst.io/modules/lsst.meas.base/index.html .
16 changes: 8 additions & 8 deletions doc/conf.py
@@ -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.meas.base
from documenteer.conf.pipelinespkg import *


_g = globals()
_g.update(build_package_configs(
project_name='meas_base',
version=lsst.meas.base.version.__version__))
project = "meas_base"
html_theme_options["logotext"] = project
html_title = project
html_short_title = project
8 changes: 7 additions & 1 deletion setup.cfg
Expand Up @@ -2,7 +2,13 @@
max-line-length = 110
# TODO: remove E266 when Task documentation is converted to rst in DM-14207.
ignore = E133, E226, E228, N802, N803, N806, E266, N812, N815, N816, W503
exclude = __init__.py, tests/testLib.py
exclude =
bin,
doc/conf.py,
**/*/__init__.py,
**/*/version.py,
tests/.tests,
tests/testLib.py

[tool:pytest]
addopts = --flake8
Expand Down