Skip to content

Commit 2d5b54b

Browse files
authored
INFRA: Update contributing and readme and add circle ci (#7)
1 parent 3e92059 commit 2d5b54b

File tree

6 files changed

+125
-4
lines changed

6 files changed

+125
-4
lines changed

.circleci/config.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
version: 2.1
2+
jobs:
3+
build_book:
4+
docker:
5+
- image: cimg/python:3.9
6+
steps:
7+
- checkout
8+
- run:
9+
name: setup environment
10+
command: |
11+
pip install --upgrade pip
12+
pip install nox
13+
pip list
14+
- run:
15+
name: Build book html
16+
command: nox -s docs
17+
18+
- store_artifacts:
19+
path: _build/html
20+
destination: html
21+
22+
# Tell CircleCI to use this workflow when it builds the site
23+
workflows:
24+
version: 2
25+
build_book:
26+
jobs:
27+
- build_book

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# <img src="images/logo/logo.png" width=40 /> pyOpenSci Packaging Guide
1+
# <img src="images/logo/logo.png" width=40 /> pyOpenSci Scientific Python Open Source Packaging Guide
22

33
![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/python-package-guide?color=purple&display_name=tag&style=plastic)
44

_static/pyos.css

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
html, body {
2+
font-size: 1.1rem;
3+
}
4+
5+
body p {
6+
/* font-family: $header-font; */
7+
font-size: 1em;
8+
font-family: 'Verdana', sans-serif!important;
9+
color: #555!important;
10+
line-height: 1.5em;
11+
}
12+
13+
h1, h2, h3 {
14+
font-family: 'Trebuchet MS', sans-serif;
15+
color: #333!important;
16+
}
17+
18+
h1 {
19+
padding-bottom: 1em!important;
20+
}
21+
22+
h3 {
23+
padding-top: 1.4em;
24+
margin-bottom: 14px;
25+
}
26+
27+
/* hide the right sidebar */
28+
.col-md-3 .bd-toc .show .noprint {
29+
display: none!important;
30+
}
31+
32+
#main-content {
33+
max-width: 80%;
34+
}
35+
36+
.bd-toc {
37+
color: #1abc9c;
38+
}
39+
40+
@media (min-width: 720px){
41+
.col-md-3 {
42+
flex: 0 0 25%;
43+
/* max-width: 25%; */
44+
display: none!important;
45+
}
46+
}
47+
48+
49+
/* HEADER BLOCK 2 */
50+
div.header__block {
51+
color: #222;
52+
}
53+
54+
.announcement div {
55+
background-color: #ccc;
56+
}
57+
58+
.header-item.announcement, .header-item.announcement .noprint {
59+
background-color:#ccc;
60+
}
61+
62+
div .announcement .header-item .noprint, header-item.announcement {
63+
background-color: #ccc!important;
64+
}
65+
66+
/* notes */
67+
68+
div.admonition.note .admonition-title, div.admonition.note .admonition-title::before {
69+
background-color: #C1CFD4;
70+
color: #222;
71+
72+
}
73+
74+
div.admonition.note {
75+
border-color: #C1CFD4;
76+
background-color: #E3F4FA;
77+
}
78+
79+
80+
div.admonition.important .admonition-title, div.admonition.important .admonition-title::before {
81+
background-color: #107762;
82+
color: #ffffff!important;
83+
}
84+
85+
div.admonition.important .admonition-title {
86+
background-color: #107762;
87+
border-color: #1abc9c;
88+
}
89+
90+
div.admonition.important {
91+
border-color: #0e6654;
92+
background-color: #ecfcf9;
93+
}

conf.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
# ones.
3333
extensions = [
3434
"myst_nb",
35-
# "myst_parser",
3635
"sphinx_design",
3736
"sphinx_copybutton",
3837
"sphinx.ext.intersphinx"
@@ -47,9 +46,10 @@
4746
"repository_url": "https://github.com/pyopensci/python-package-guide",
4847
"use_repository_button": True,
4948
"google_analytics_id": "UA-141260825-1",
49+
"show_toc_level": 1,
50+
"toc_title": "On this page",
5051
"external_links": [
51-
{"name": "link-one-name", "url": "https://www.pyopensci.org"},
52-
{"name": "link-two-name", "url": "https://pyopensci.org"}
52+
{"pyOpenSci Website": "link-one-name", "url": "https://www.pyopensci.org"}
5353
],
5454
"announcement": "🚧 UNDER CONSTRUCTION: this guide is under heavy construction right now. 🚧"
5555
}
@@ -79,6 +79,7 @@
7979
#
8080
html_theme = 'sphinx_book_theme'
8181
html_static_path = ["_static"]
82+
html_css_files = ["pyos.css"]
8283
html_title = "pyOpenSci Package Guide"
8384
html_logo = "images/logo/logo.png"
8485

images/logo/favicon.ico

16.7 KB
Binary file not shown.

images/logo/logo.png

9.62 KB
Loading

0 commit comments

Comments
 (0)