Skip to content
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

Remove ecosystem stuff and port to scientific-python-hugo-theme #413

Merged
merged 14 commits into from
Oct 21, 2021
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
8 changes: 3 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
build/
_build/
*.swp
*.pyc
public/
resources/
*~
*.bak
**/__pycache__
6 changes: 3 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "scipy-sphinx-theme"]
path = scipy-sphinx-theme
url = https://github.com/scipy/scipy-sphinx-theme.git
[submodule "themes/scientific-python-hugo-theme"]
path = themes/scientific-python-hugo-theme
url = https://github.com/scientific-python/scientific-python-hugo-theme.git
32 changes: 32 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
HTMLDIR=public
USERNAME=rgommers

BASEURL ?=

ifdef BASEURL
BASEURLARG=-b $(BASEURL)
endif

.PHONY: help clean html


help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " upload USERNAME=user to upload the generated pages to scipy.org"
@echo " html to make standalone HTML files"

clean: ## remove the build artifacts, mainly the "public" directory
rm -rf $(HTMLDIR)

prepare: clean
git submodule update --init --recursive

html: prepare ## build the website in ./public
hugo $(BASEURLARG)

serve:
@hugo --i18n-warnings --buildDrafts server


serve-dev:
@hugo --i18n-warnings --buildDrafts server --disableFastRender
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,17 @@
# Scipy.org Website Source Code

This repository contains the Sphinx source for the [SciPy website](http://www.scipy.org/).
# scipy.org

After cloning this repository, run
## Build

```
$ git submodule init
$ git submodule update
git submodule update --init --recursive
make hugo
```

to get the Sphinx theme used.
The pages are in `public/`.

The source is in the `www` directory, `cd` there, then the following
commands apply:

To make a local build of the website

`$ cd www`
`$ make html`

To build and upload the site (requires ssh access to www.scipy.org,
and if you're on macOS then upgrade rsync with Homebrew first):

`$ make upload USERNAME=myusername`

To test external links from the site

`$ make linkcheck`
To run the development server, which hosts the site and recompiles
automatically on edits:

```
make serve
```
6 changes: 6 additions & 0 deletions archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

126 changes: 126 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
baseURL: https://scipy.scientific-python.org/
languageCode: en-us
theme: scientific-python-hugo-theme
disableKinds: ["taxonomy", "term"]
DefaultContentLanguage: en
markup:
goldmark:
renderer:
unsafe: true

# Uncomment this to disable the translations for the specified languages.
# This may be useful to be able to merge partial translations without deploying
# them to scipy.org immediately.
# disableLanguages: ["pt", "ja"]

params:
images:
- /images/logo.svg
navColor: blue
font:
name: "Lato"
sizes: [400,900]

languages:
en:
title: SciPy
weight: 1
contentDir: content/en

languageName: English
params:
description: Why SciPy? Fundamental algorithms. Broadly applicable. Foundational. Interoperable. Performant. Open source.
navbarlogo:
image: logo.svg
altText: A blue circle with a snake in the shape of the letter 'S'.
link: /
hero:
# Main hero title
title: SciPy
# Hero subtitle (optional)
subtitle: Fundamental algorithms for scientific computing in Python
# Button text
buttontext: Get started
# Where the main hero button links to
buttonlink: "/install"
# Hero image (from static/images/___)
image: logo.svg
# Customizable navbar. For a dropdown, add a "sublinks" list.
news:
title: SciPy 1.7.1 released
content: 2021-08-01
url: /news

keyfeatures:
features:
- title: Fundamental algorithms
text: SciPy provides algorithms for optimization, integration, interpolation, eigenvalue problems, algebraic equations, differential equations, statistics and many other classes of problems.
- title: Broadly applicable
text: The algorithms and data structures provided by SciPy are broadly applicable across domains.
- title: Foundational
text: Extends NumPy providing additional tools for array computing and provides specialized data structures, such as sparse matrices and k-dimensional trees.
- title: Performant
text: SciPy wraps highly-optimized implementations written in low-level languages like Fortran, C, and C++. Enjoy the flexibility of Python with the speed of compiled code.
- title: Easy to use
text: SciPy's high level syntax makes it accessible and productive for programmers from any background or experience level.
- title: Open source
text: Distributed under a liberal [BSD license](https://github.com/scipy/scipy/blob/master/LICENSE.txt), SciPy is developed and maintained [publicly on GitHub](https://github.com/scipy/scipy) by a vibrant, responsive, and diverse [community](/dev-zone).

section5: false


navbar:
- title: Install
url: /install
- title: Documentation
url: https://scipy.github.io/devdocs/index.html
- title: Download
url: /download
- title: Mailing Lists
url: /mailing-lists
- title: Report bugs
url: /bug-report
footer:
logo: logo.svg
socialmediatitle: ""
socialmedia:
- link: https://github.com/scipy/scipy
icon: github
quicklinks:
column1:
title: ""
links:
- text: Install
link: /install
- text: Documentation
link: https://scipy.github.io/devdocs/index.html
- text: Citing SciPy
link: /citing-scipy
- text: Roadmap
link: https://scipy.github.io/devdocs/dev/roadmap.html
- text: Donate
link: /donations
column2:
links:
- text: About Us
link: https://scipy.github.io/devdocs/dev/governance/people.html
- text: Code of Conduct
link: http://scipy.github.io/devdocs/dev/conduct/code_of_conduct.html
- text: Developer Zone
link: /dev-zone
- text: Mailing Lists
link: /mailing-lists
- text: SciPy Conference
link: https://conference.scipy.org/
column3:
links:
- text: FAQ
link: /faq
- text: Get Help
link: /gethelp
- text: Terms of Use
link: /terms
- text: Privacy
link: /privacy
- text: Press Kit
link: /press-kit
61 changes: 61 additions & 0 deletions content/en/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Bug reports
sidebar: false
---

**Please help us by reporting any problems you find.**

SciPy uses GitHub to do project management.
There, you can see what we are currently working on (Pull Requests), as
well as file bug-reports (issues).

1. Go to the relevant page:
- [Pull requests](https://github.com/scipy/scipy/pulls)
- [Bug reports](https://github.com/scipy/scipy/issues)
2. On GitHub, you need to register an account the first time you use
it.
3. Make sure the bug hasn\'t already been reported. Click on \"Search\"
and type in some keywords to search for.
4. File your bug-report by clicking \"New Issue\" on GitHub. For advice
on how to provide a useful bug report, see the
[guidelines for submitting bugs](#guidelines-for-submitting-bugs).
5. Note that the bug trackers are mostly for actual bugs. If you want
to propose an enhancement, then the mailing list is a better place
to get feedback.

**Thank you for helping to make** SciPy **better!**

# Guidelines for submitting bugs

- Provide a good description. Tickets in the vein of \"SciPy is
BROKEN!!!\" are not useful; rather, please state the problem
clearly, e.g., \"scipy.ndimage ignores keyword \'axis\'\".

- Include a minimal standalone code snippet to illustrate the problem.
Try to narrow it down to a few lines.

- If you experience segfaults or memory errors, give a GDB traceback:

$ gdb python
GNU gdb 6.3.50-20050815 (Apple version gdb-573) (Fri Oct 20 15:50:43 GMT 2006)
Copyright 2004 Free Software Foundation, Inc.
GDB is free software, covered by the GNU General Public License, and you are
welcome to change it and/or distribute copies of it under certain conditions.
Type "show copying" to see the conditions.
There is absolutely no warranty for GDB. Type "show warranty" for details.
This GDB was configured as "i386-apple-darwin"...Reading symbols for shared
libraries .. done
(gdb) run -c "import scipy; scipy.test(10,10)"
Starting program: /usr/local/bin/python -c "import scipy; scipy.test()"
Reading symbols for shared libraries . done
Program received signal SIGTRAP, Trace/breakpoint trap.
0x8fe01010 in __dyld__dyld_start ()
(gdb) c
Continuing.
Reading symbols for shared libraries . done
Reading symbols for shared libraries . done
...

Then use the \"bt\" command after the segfault happens to get the
backtrace. Alternatively, run the code using
[Valgrind](http://valgrind.org/).
49 changes: 49 additions & 0 deletions content/en/citing-scipy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Citing SciPy
sidebar: false
---

If SciPy has been significant in your research, and you would like to
acknowledge the project in your academic publication, we suggest citing the
following paper:

Pauli Virtanen, Ralf Gommers, Travis E. Oliphant, Matt Haberland, Tyler
Reddy, David Cournapeau, Evgeni Burovski, Pearu Peterson, Warren
Weckesser, Jonathan Bright, Stéfan J. van der Walt, Matthew Brett,
Joshua Wilson, K. Jarrod Millman, Nikolay Mayorov, Andrew R. J. Nelson,
Eric Jones, Robert Kern, Eric Larson, CJ Carey, İlhan Polat, Yu Feng,
Eric W. Moore, Jake VanderPlas, Denis Laxalde, Josef Perktold, Robert
Cimrman, Ian Henriksen, E.A. Quintero, Charles R Harris, Anne M.
Archibald, Antônio H. Ribeiro, Fabian Pedregosa, Paul van Mulbregt, and
SciPy 1.0 Contributors. (2020) **SciPy 1.0: Fundamental Algorithms for
Scientific Computing in Python**. *Nature Methods*, 17(3), 261-272.

Here\'s an example of a BibTeX entry:

@ARTICLE{2020SciPy-NMeth,
author = {Virtanen, Pauli and Gommers, Ralf and Oliphant, Travis E. and
Haberland, Matt and Reddy, Tyler and Cournapeau, David and
Burovski, Evgeni and Peterson, Pearu and Weckesser, Warren and
Bright, Jonathan and {van der Walt}, St{\'e}fan J. and
Brett, Matthew and Wilson, Joshua and Millman, K. Jarrod and
Mayorov, Nikolay and Nelson, Andrew R. J. and Jones, Eric and
Kern, Robert and Larson, Eric and Carey, C J and
Polat, {\.I}lhan and Feng, Yu and Moore, Eric W. and
{VanderPlas}, Jake and Laxalde, Denis and Perktold, Josef and
Cimrman, Robert and Henriksen, Ian and Quintero, E. A. and
Harris, Charles R. and Archibald, Anne M. and
Ribeiro, Ant{\^o}nio H. and Pedregosa, Fabian and
{van Mulbregt}, Paul and {SciPy 1.0 Contributors}},
title = {{{SciPy} 1.0: Fundamental Algorithms for Scientific
Computing in Python}},
journal = {Nature Methods},
year = {2020},
volume = {17},
pages = {261--272},
adsurl = {https://rdcu.be/b08Wh},
doi = {10.1038/s41592-019-0686-2},
}

For any specific algorithm, also consider citing the original author\'s
paper (this can often be found under the \"References\" section of the
docstring).
Loading