Skip to content

Commit

Permalink
Merge pull request #39 from lsst/tickets/DM-30015
Browse files Browse the repository at this point in the history
DM-30015: Update conf.py for documenteer 0.6
  • Loading branch information
timj committed Dec 7, 2021
2 parents 195efb4 + 8c1ca8a commit d2200ce
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Firefly is IPAC's toolkit for construction of astronomical data user interfaces.

## Pointers to more information

* Full documentation is available at https://display-firefly.lsst.io/ .
* Full documentation is available at https://pipelines.lsst.io/modules/lsst.display.firefly/ .
* Within the Rubin Science Platform environment, suitable Firefly servers
are provided by default, so that in many cases the user need not be aware
of the identity or URL of the server.
Expand Down Expand Up @@ -35,12 +35,12 @@ managed via Conda and supplied via the `rubin-env` mechanism.
## Usage

Usage is described in detail in
the [documentation](https://display-firefly.lsst.io/).
the [documentation](https://pipelines.lsst.io/modules/lsst.display.firefly/).
However, in many cases the following is sufficient to set up a Firefly
display for use with the back-end-agnostic `afw.display` interface:

```
import lsst.afw.display as afwDisplay
afwDisplay.setDefaultBackend(firefly)
afwDisplay.setDefaultBackend('firefly')
afw_display = afwDisplay.Display(frame=1)
```
16 changes: 8 additions & 8 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#!/usr/bin/env python
"""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.display.firefly
from documenteer.conf.pipelinespkg import *


_g = globals()
_g.update(build_package_configs(
project_name='display_firefly',
version=lsst.display.firefly.version.__version__))
project = "display_firefly"
html_theme_options["logotext"] = project
html_title = project
html_short_title = project
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ max-line-length = 110
ignore = E133, E226, E228, N802, N803, N806, N812, N815, N816, W504
exclude =
bin,
doc,
doc/conf.py,
**/*/__init__.py,
**/*/version.py,
tests/.tests
Expand Down

0 comments on commit d2200ce

Please sign in to comment.