diff --git a/Makefile b/Makefile index 5e11bc2..b0a4348 100644 --- a/Makefile +++ b/Makefile @@ -22,14 +22,14 @@ external: cookie html: ## Build learn site (without external content) in `./public` html: prepare - hugo + jupyter-book build . --path-output public html-all: ## Buildlearn site (with external content) in `./public` html-all: html external serve: ## Serve site, typically on http://localhost:1313 serve: prepare - @hugo --printI18nWarnings server + python -m http.server --directory public/_build/html 1313 clean: ## Remove built files clean: diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..73390c6 --- /dev/null +++ b/_config.yml @@ -0,0 +1,70 @@ +# _config.yml +title: learn.scientific-python.org +only_build_toc_files: true + +# Keep things simple and MyST-first +parse: + myst_enable_extensions: [] + +sphinx: + config: + extra_extensions: + - sphinx_design + # --- Theme / branding --- + html_theme: pydata_sphinx_theme + html_title: "Learn Scientific Python" + html_logo: "static/images/logo.svg" + + # Make your existing assets available to Sphinx + html_static_path: + - "assets" + - "static" + + # Reuse existing custom CSS (assets/css/custom.css) + html_css_files: + - "css/custom.css" + + # --- PyData theme options (navbar/footer-ish) --- + html_theme_options: + navbar_align: "content" + + # Top navbar links (mirrors the old site’s cross-network navigation) + external_links: + - name: "Home" + url: "https://scientific-python.org/" + - name: "Blog" + url: "https://blog.scientific-python.org" + - name: "Learn" + url: "https://learn.scientific-python.org/" + - name: "Tools" + url: "https://tools.scientific-python.org" + + # Social icons (footer/header icons) + icon_links: + - name: "GitHub" + url: "https://github.com/scientific-python/" + icon: "fab fa-github" + - name: "YouTube" + url: "https://www.youtube.com/c/ScientificPython-org" + icon: "fab fa-youtube" + - name: "Mastodon" + url: "https://fosstodon.org/@scientific_python" + icon: "fab fa-mastodon" + - name: "Discourse" + url: "https://discuss.scientific-python.org" + icon: "fas fa-comments" + - name: "Discord" + url: "https://discord.com/invite/vur45CbwMz" + icon: "fab fa-discord" + + # Reduce “book-like” chrome to feel more like a website + show_nav_level: 2 + navigation_with_keys: false + # Don't even look at generated content + exclude_patterns: + - "content/_build/**" + - "public/**" + - ".github/**" + - "external-content/**" + - "**/.ipynb_checkpoints" + - "**/.DS_Store" diff --git a/_toc.yml b/_toc.yml new file mode 100644 index 0000000..4720056 --- /dev/null +++ b/_toc.yml @@ -0,0 +1,46 @@ +format: jb-book +root: content/_index + +parts: + - caption: About + chapters: + - file: content/about/_index + - file: content/about/governance + + - caption: Community + chapters: + - file: content/community/_index + - file: content/community/role + - file: content/community/skills + - file: content/community/community-meetings + - file: content/community/community-outreach + - file: content/community/onboarding + - file: content/community/project-management + + - caption: Contributors + chapters: + - file: content/contributors/_index + - file: content/contributors/why-contribute + - file: content/contributors/getting-started + - file: content/contributors/choosing-a-project + - file: content/contributors/first-contribution + - file: content/contributors/ways-to-contribute + - file: content/contributors/setup/install + - file: content/contributors/setup/ecosystem + - file: content/contributors/setup/next-steps + + - caption: Documentation + chapters: + - file: content/documentation/_index + - file: content/documentation/accessible-documentation + + - caption: Maintainers + chapters: + - file: content/maintainers/_index + - file: content/maintainers/meeting_types + - file: content/maintainers/managing-conflict + - file: content/maintainers/interacting-with-new-contributors + + - caption: Roadmap + chapters: + - file: content/roadmap diff --git a/assets/css/custom.css b/assets/css/custom.css index 9c5e964..f22d33c 100644 --- a/assets/css/custom.css +++ b/assets/css/custom.css @@ -1,3 +1,24 @@ .navbar-logo-text { font-family: "Lato"; } +/* --- Make layout feel less "book-ish" and closer to a website --- */ +.bd-main .bd-content .bd-article-container { + max-width: 900px; /* keep readable, less wide than default "docs" feel */ +} + +h1, +h2, +h3, +h4 { + letter-spacing: -0.01em; +} + +/* Slightly tighten the top spacing so it feels more like a marketing/docs site */ +.bd-header { + box-shadow: none; +} + +/* If the left sidebar feels too dominant, reduce its visual weight */ +.bd-sidebar-primary { + border-right: 0; +} diff --git a/content/_index.md b/content/_index.md index bcecd6c..a16b2d2 100644 --- a/content/_index.md +++ b/content/_index.md @@ -2,7 +2,22 @@ title: --- -{{< grid columns="1 2 2 2" >}} +````{grid} 1 2 2 2 +:gap: 3 + +```{grid-item-card} Contributor Guide +:link: /contributors/ +:shadow: md + +Learn how to join the Scientific Python community! +``` +```{grid-item-card} Development Guide +:link: /development/ +:shadow: md + +Learn recommended tools and approaches for developing Scientific Python libraries. +``` +```` [[item]] type = 'card'