Skip to content

Enh: Redesign of packaging guide landing page #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added _static/fonts/poppins-v20-latin-500.woff2
Binary file not shown.
Binary file added _static/fonts/poppins-v20-latin-600.woff2
Binary file not shown.
51 changes: 51 additions & 0 deletions _static/pyos.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@

}


/* anything related to the dark theme */
html[data-theme="dark"] {
--pst-color-info-bg: #400f59!important;
}


html, body {
font-size: 1.0rem;
}
Expand Down Expand Up @@ -248,3 +255,47 @@ html[data-theme=dark] {
font-weight: 400;
src: url('./fonts/itim-v14-latin-regular.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}

/* poppins-500 - latin */
@font-face {
font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */
font-family: 'Poppins';
font-style: normal;
font-weight: 500;
src: url('./fonts/poppins-v20-latin-500.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* poppins-600 - latin */
@font-face {
font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */
font-family: 'Poppins';
font-style: normal;
font-weight: 600;
src: url('./fonts/poppins-v20-latin-600.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* Cards */

/* todo light and dark adaptations needed */

.sd-card-title {
margin-bottom: 0.5rem;
background-color: var(--pst-color-info-bg)!important;
padding: .5rem;
border-bottom: 2px solid #999;
font-size: 1.2rem;
font-weight: 600!important;
}

.sd-card-header {
font-size: 1.2em;
font-weight: 600;
}

.sd-card-body {
padding: 0 0!important;


.left-aligned
& ul li {
text-align: left;
}
}
6 changes: 3 additions & 3 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"href": "https://www.pyopensci.org/images/favicon.ico",
},
],
"announcement": "<p><a href='https://www.pyopensci.org/software-peer-review/about/intro.html'>Submit Your Python Package for Peer Review - Learn More!</a></p>🚧 This guide is currently being developed! 🚧 ",
"announcement": "<p><a href='https://www.pyopensci.org/about-peer-review/index.html'>We run peer review of scientific Python software. Learn more.</a></p>",
#"navbar_center": ["nav"], this can be a way to override the default navigation structure
"external_links": [
{
Expand All @@ -82,12 +82,12 @@
},
],
"logo": {
"text": "Python Packaging",
#"text": "Python Packaging",
"image_dark": "logo-dark-mode.png",
"image_light": "logo-light-mode.png",
"alt_text": "pyOpenSci Python Package Guide. The pyOpenSci logo is a purple flower with pyOpenSci under it. The o in open sci is the center of the flower",
},
"header_links_before_dropdown": 4,
"header_links_before_dropdown": 3,
"use_edit_page_button": True,
"show_nav_level": 2,
"navigation_depth": 3,
Expand Down
17 changes: 13 additions & 4 deletions documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,30 @@ Create Package Tutorials <write-user-documentation/create-package-tutorials.md>

```{toctree}
:hidden:
:caption: Core Repository Files
:caption: Docs for Contributors & Maintainers
:maxdepth: 2

Intro <repository-files/intro.md>
README file <repository-files/readme-file-best-practices.md>

Contributing File <repository-files/contributing-file.md>
Code of Conduct File <repository-files/code-of-conduct-file.md>

Development Guide <repository-files/development-guide.md>
```

```{toctree}
:hidden:
:caption: Community Docs
:maxdepth: 2

README file <repository-files/readme-file-best-practices.md>
Code of Conduct File <repository-files/code-of-conduct-file.md>
LICENSE files <repository-files/license-files.md>
```

```{toctree}
:maxdepth: 2
:hidden:
:caption: Documentation & Hosting Tools
:caption: Publication tools for your docs

Intro <hosting-tools/intro>
Sphinx for Docs <hosting-tools/sphinx-python-package-documentation-tools>
Expand Down
Binary file added images/tutorials/packaging-elements.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading