Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
squarebot[bot] committed Nov 6, 2024
0 parents commit e6193d4
Show file tree
Hide file tree
Showing 14 changed files with 566 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
12 changes: 12 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: CI

'on': [push, pull_request, workflow_dispatch]

jobs:
call-workflow:
uses: lsst-sqre/rubin-sphinx-technote-workflows/.github/workflows/ci.yaml@v1
with:
handle: sitcomtn-147
secrets:
ltd_username: ${{ secrets.LTD_USERNAME }}
ltd_password: ${{ secrets.LTD_PASSWORD }}
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_build/
.technote/
.tox/
venv/
.venv/
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
# - id: trailing-whitespace
- id: check-yaml
- id: check-toml
1 change: 1 addition & 0 deletions COPYRIGHT
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Copyright 2024 Association of Universities for Research in Astronomy, Inc. (AURA)
395 changes: 395 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.PHONY:
init:
pip install tox pre-commit
pre-commit install

.PHONY:
html:
tox run -e html

.PHONY:
lint:
tox run -e lint,linkcheck

.PHONY:
add-author:
tox run -e add-author

.PHONY:
sync-authors:
tox run -e sync-authors

.PHONY:
clean:
rm -rf _build
rm -rf .technote
rm -rf .tox
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[![Website](https://img.shields.io/badge/sitcomtn--147-lsst.io-brightgreen.svg)](https://sitcomtn-147.lsst.io)
[![CI](https://github.com/lsst-sitcom/sitcomtn-147/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-sitcom/sitcomtn-147/actions/workflows/ci.yaml)

# M2 Response to short and long slews

## SITCOMTN-147

write something

**Links:**

- Publication URL: https://sitcomtn-147.lsst.io
- Alternative editions: https://sitcomtn-147.lsst.io/v
- GitHub repository: https://github.com/lsst-sitcom/sitcomtn-147
- Build system: https://github.com/lsst-sitcom/sitcomtn-147/actions/


## Build this technical note

You can clone this repository and build the technote locally if your system has Python 3.11 or later:

```sh
git clone https://github.com/lsst-sitcom/sitcomtn-147
cd sitcomtn-147
make init
make html
```

Repeat the `make html` command to rebuild the technote after making changes.
If you need to delete any intermediate files for a clean build, run `make clean`.

The built technote is located at `_build/html/index.html`.

## Publishing changes to the web

This technote is published to https://sitcomtn-147.lsst.io whenever you push changes to the `main` branch on GitHub.
When you push changes to a another branch, a preview of the technote is published to https://sitcomtn-147.lsst.io/v.

## Editing this technical note

The main content of this technote is in `index.md` (a Markdown file parsed as [CommonMark/MyST](https://myst-parser.readthedocs.io/en/latest/index.html)).
Metadata and configuration is in the `technote.toml` file.
For guidance on creating content and information about specifying metadata and configuration, see the Documenteer documentation: https://documenteer.lsst.io/technotes.
4 changes: 4 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# See the Documenteer docs for how to customize conf.py:
# https://documenteer.lsst.io/technotes/

from documenteer.conf.technote import * # noqa F401 F403
9 changes: 9 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# M2 Response to short and long slews

```{abstract}
write something
```

## Add content here

See the [Documenteer documentation](https://documenteer.lsst.io/technotes/index.html) for tips on how to write and configure your new technote.
Empty file added local.bib
Empty file.
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
documenteer[technote]>=1.0.0a13
23 changes: 23 additions & 0 deletions technote.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[technote]
id = "SITCOMTN-147"
series_id = "SITCOMTN"
canonical_url = "https://sitcomtn-147.lsst.io"
github_url = "https://github.com/lsst-sitcom/sitcomtn-147"
github_default_branch = "main"
date_created = 2024-11-06T17:06:15Z
organization.name = "Vera C. Rubin Observatory"
organization.ror = "https://ror.org/048g3cy84"
license.id = "CC-BY-4.0"

[technote.status]
state = "draft"

[[technote.authors]]
name.given = "Bruno C."
name.family = "Quint"
internal_id = "quintb"
orcid = "https://orcid.org/0000-0002-1557-3560"
[[technote.authors.affiliations]]
name = "Vera C. Rubin Observatory Project Office"
internal_id = "RubinObs"
address = "950 N. Cherry Ave., Tucson, AZ 85719, USA"
29 changes: 29 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[tox]
environments = html
isolated_build = True

[testenv]
skip_install = true
deps =
-rrequirements.txt

[testenv:html]
commands =
sphinx-build --keep-going -n -W -T -b html -d _build/doctrees . _build/html

[testenv:linkcheck]
commands =
sphinx-build --keep-going -n -W -T -b linkcheck -d _build/doctrees . _build/linkcheck

[testenv:lint]
deps = pre-commit
commands =
pre-commit run --all-files

[testenv:add-author]
commands =
documenteer technote add-author

[testenv:sync-authors]
commands =
documenteer technote sync-authors

0 comments on commit e6193d4

Please sign in to comment.