Skip to content

Commit 027ab70

Browse files
committed
restructure removing dev and user folders
1 parent 554ac78 commit 027ab70

File tree

95 files changed

+29
-680
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+29
-680
lines changed

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ docker: false
1010
docs_type: sphinx
1111
git_platform: github.com
1212
github_org: epics-containers
13-
package_name: epic_containers
13+
package_name: epics-containers
1414
repo_name: epic-containers.github.io
1515
type_checker: mypy

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
[![CI](https://github.com/epics-containers/epic-containers.github.io/actions/workflows/ci.yml/badge.svg)](https://github.com/epics-containers/epic-containers-github-io/actions/workflows/ci.yml)
2-
[![Coverage](https://codecov.io/gh/epics-containers/epic-containers.github.io/branch/main/graph/badge.svg)](https://codecov.io/gh/epics-containers/epic-containers-github-io)
3-
[![PyPI](https://img.shields.io/pypi/v/epic-containers.svg)](https://pypi.org/project/epic-containers)
42
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
53

6-
# epic_containers
4+
# epics-containers
75

86
Documentation for the epics-containers framework
97

@@ -21,15 +19,15 @@ some relevant examples. If it is a library then you might put some
2119
introductory code here:
2220

2321
```python
24-
from epic_containers import __version__
22+
from epics-containers import __version__
2523

26-
print(f"Hello epic_containers {__version__}")
24+
print(f"Hello epics-containers {__version__}")
2725
```
2826

2927
Or if it is a commandline tool then you might put some example commands here:
3028

3129
```
32-
python -m epic_containers --version
30+
python -m epics-containers --version
3331
```
3432

3533
<!-- README only content. Anything below this line won't be included in index.md -->

docs/conf.py

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,17 @@
55
# https://www.sphinx-doc.org/en/master/usage/configuration.html
66

77
import sys
8-
from pathlib import Path
9-
from subprocess import check_output
108

119
import requests
1210

13-
import epic_containers
14-
1511
# -- General configuration ------------------------------------------------
1612

13+
# TODO do we want to set this from code?
14+
version = "1.0"
15+
1716
# General information about the project.
1817
project = "epic-containers.github.io"
1918

20-
# The full version, including alpha/beta/rc tags.
21-
release = epic_containers.__version__
22-
23-
# The short X.Y version.
24-
if "+" in release:
25-
# Not on a tag, use branch name
26-
root = Path(__file__).absolute().parent.parent
27-
git_branch = check_output("git branch --show-current".split(), cwd=root)
28-
version = git_branch.decode().strip()
29-
else:
30-
version = release
31-
3219
extensions = [
3320
# Use this for generating API docs
3421
"sphinx.ext.autodoc",

docs/developer/explanations/decisions.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/developer/explanations/decisions/0001-record-architecture-decisions.rst

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/developer/explanations/decisions/0002-switched-to-pip-skeleton.rst

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/developer/how-to/build-docs.rst

Lines changed: 0 additions & 38 deletions
This file was deleted.

docs/developer/how-to/contribute.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/developer/how-to/make-release.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/developer/how-to/update-tools.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)