diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 000000000..1e795c55d --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,27 @@ +version: 2.1 +jobs: + build_book: + docker: + - image: cimg/python:3.9 + steps: + - checkout + - run: + name: setup environment + command: | + pip install --upgrade pip + pip install nox + pip list + - run: + name: Build book html + command: nox -s docs + + - store_artifacts: + path: _build/html + destination: html + +# Tell CircleCI to use this workflow when it builds the site +workflows: + version: 2 + build_book: + jobs: + - build_book diff --git a/README.md b/README.md index 5b8dd393a..c41822d7b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pyOpenSci Packaging Guide +# pyOpenSci Scientific Python Open Source Packaging Guide ![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/python-package-guide?color=purple&display_name=tag&style=plastic) diff --git a/_static/pyos.css b/_static/pyos.css new file mode 100644 index 000000000..f894a1d8b --- /dev/null +++ b/_static/pyos.css @@ -0,0 +1,93 @@ +html, body { + font-size: 1.1rem; +} + +body p { + /* font-family: $header-font; */ + font-size: 1em; + font-family: 'Verdana', sans-serif!important; + color: #555!important; + line-height: 1.5em; +} + +h1, h2, h3 { + font-family: 'Trebuchet MS', sans-serif; + color: #333!important; +} + +h1 { + padding-bottom: 1em!important; +} + +h3 { + padding-top: 1.4em; + margin-bottom: 14px; +} + +/* hide the right sidebar */ +.col-md-3 .bd-toc .show .noprint { + display: none!important; +} + +#main-content { + max-width: 80%; +} + +.bd-toc { + color: #1abc9c; +} + +@media (min-width: 720px){ +.col-md-3 { + flex: 0 0 25%; + /* max-width: 25%; */ + display: none!important; + } +} + + +/* HEADER BLOCK 2 */ +div.header__block { +color: #222; +} + +.announcement div { +background-color: #ccc; +} + +.header-item.announcement, .header-item.announcement .noprint { + background-color:#ccc; +} + +div .announcement .header-item .noprint, header-item.announcement { + background-color: #ccc!important; +} + +/* notes */ + +div.admonition.note .admonition-title, div.admonition.note .admonition-title::before { + background-color: #C1CFD4; + color: #222; + +} + +div.admonition.note { + border-color: #C1CFD4; + background-color: #E3F4FA; +} + + +div.admonition.important .admonition-title, div.admonition.important .admonition-title::before { +background-color: #107762; +color: #ffffff!important; +} + +div.admonition.important .admonition-title { +background-color: #107762; +border-color: #1abc9c; +} + +div.admonition.important { + border-color: #0e6654; + background-color: #ecfcf9; +} diff --git a/conf.py b/conf.py index d32f54142..1839adea9 100644 --- a/conf.py +++ b/conf.py @@ -32,7 +32,6 @@ # ones. extensions = [ "myst_nb", - # "myst_parser", "sphinx_design", "sphinx_copybutton", "sphinx.ext.intersphinx" @@ -47,9 +46,10 @@ "repository_url": "https://github.com/pyopensci/python-package-guide", "use_repository_button": True, "google_analytics_id": "UA-141260825-1", + "show_toc_level": 1, + "toc_title": "On this page", "external_links": [ - {"name": "link-one-name", "url": "https://www.pyopensci.org"}, - {"name": "link-two-name", "url": "https://pyopensci.org"} + {"pyOpenSci Website": "link-one-name", "url": "https://www.pyopensci.org"} ], "announcement": "🚧 UNDER CONSTRUCTION: this guide is under heavy construction right now. 🚧" } @@ -79,6 +79,7 @@ # html_theme = 'sphinx_book_theme' html_static_path = ["_static"] +html_css_files = ["pyos.css"] html_title = "pyOpenSci Package Guide" html_logo = "images/logo/logo.png" diff --git a/images/logo/favicon.ico b/images/logo/favicon.ico new file mode 100644 index 000000000..eb2cf42e7 Binary files /dev/null and b/images/logo/favicon.ico differ diff --git a/images/logo/logo.png b/images/logo/logo.png new file mode 100644 index 000000000..ea39fc27e Binary files /dev/null and b/images/logo/logo.png differ