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

Merged
merged 4 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
2 changes: 1 addition & 1 deletion .github/workflows/cmake.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
pybind11[global] \
pytest \
pytest-flake8 \
git+https://github.com/lsst/utils@master#egg=lsst_utils
git+https://github.com/lsst/utils@main#egg=lsst_utils

- name: CMake configure
run: |
Expand Down
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
###
log
###

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

The ``lsst.log`` module provides logging for C++ and Python.
Documentation is available at https://pipelines.lsst.io/modules/lsst.log/index.html.
3 changes: 2 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""Sphinx configuration file for an LSST stack package.

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.conf.pipelinespkg import * # noqa: F403, import *
Expand Down
7 changes: 6 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
[flake8]
max-line-length = 110
ignore = E133, E226, E228, N802, N803, N806, W503
exclude = __init__.py
exclude =
bin,
doc/conf.py,
**/*/__init__.py,
**/*/version.py,
tests/.tests

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