Skip to content

Commit 444a401

Browse files
jarrodmillmanjarrodmillman
committed
Remove ecosystem stuff and port to scientific-python-hugo-theme
1 parent d2fe7c6 commit 444a401

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+5035
-3304
lines changed

‎.circleci/artifact_path‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0/public/index.html

‎.circleci/config.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
version: 2.1
2+
3+
jobs:
4+
build:
5+
working_directory: ~/repo
6+
docker:
7+
- image: cibuilds/hugo:latest
8+
9+
steps:
10+
- checkout
11+
12+
- run:
13+
name: Install hugo theme
14+
command: git submodule update --init --recursive
15+
16+
- run:
17+
name: Build site
18+
command: |
19+
sed -i '/theme/a uglyurls: true' config.yaml
20+
sed -i '/uglyurls/a relativeURLs: true' config.yaml
21+
sed -i 's/\"\/\"/\"\/index.html\"/g' config.yaml
22+
sed -i 's/\/install/\/install.html/g' config.yaml
23+
sed -i 's/\/download/\/download.html/g' config.yaml
24+
sed -i 's/\/mailing-lists/\/mailing-lists.html/g' config.yaml
25+
sed -i 's/\/bug-report/\/bug-report.html/g' config.yaml
26+
sed -i 's/\/citing-scipy/\/citing-scipy.html/g' config.yaml
27+
sed -i 's/\/donations/\/donations.html/g' config.yaml
28+
sed -i 's/\/dev-zone/\/dev-zone.html/g' config.yaml
29+
sed -i 's/\/faq/\/faq.html/g' config.yaml
30+
sed -i 's/\/gethelp/\/gethelp.html/g' config.yaml
31+
sed -i 's/\/terms/\/terms.html/g' config.yaml
32+
sed -i 's/\/privacy/\/privacy.html/g' config.yaml
33+
sed -i 's/\/press-kit/\/press-kit.html/g' config.yaml
34+
sed -i 's/\/news/\/news.html/g' config.yaml
35+
hugo
36+
37+
- store_artifacts:
38+
path: public/

‎.gitignore‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
build/
2-
_build/
3-
*.swp
4-
*.pyc
1+
public/
2+
resources/
53
*~
6-
*.bak
4+
**/__pycache__

‎.gitmodules‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
[submodule "scipy-sphinx-theme"]
2-
path = scipy-sphinx-theme
3-
url = https://github.com/scipy/scipy-sphinx-theme.git
1+
[submodule "themes/scientific-python-hugo-theme"]
2+
path = themes/scientific-python-hugo-theme
3+
url = git@github.com:scientific-python/scientific-python-hugo-theme

‎Makefile‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# type `make help` to see all options
2+
3+
# If you have naively forked this repo, say to
4+
# github.com://myname/numpy.org.git, you can test out the build via
5+
# make TARGET=myname BASEURL=https://myname.github.io/numpy.org deploy
6+
7+
TARGET ?= origin
8+
BASEURL ?=
9+
10+
ifdef BASEURL
11+
BASEURLARG=-b $(BASEURL)
12+
endif
13+
14+
all: build
15+
16+
.PHONY: serve html clean deploy help
17+
18+
.SILENT: # remove this to see the commands executed
19+
20+
serve: public ## serve the website
21+
hugo --i18n-warnings server -D
22+
23+
public: ## create a worktree branch in the public directory
24+
git worktree add -B gh-pages public $(TARGET)/gh-pages
25+
rm -rf public/*
26+
27+
html: public ## build the website in ./public
28+
hugo $(BASEURLARG)
29+
touch public/.nojekyll
30+
31+
public/.nojekyll: html
32+
33+
clean: ## remove the build artifacts, mainly the "public" directory
34+
rm -rf public
35+
git worktree prune
36+
rm -rf .git/worktrees/public
37+
38+
deploy: public/.nojekyll ## push the built site to the gh-pages of this repo
39+
cd public && git add --all && git commit -m"Publishing to gh-pages"
40+
@echo pushint to $(TARGET) gh-pages
41+
git push $(TARGET) gh-pages
42+
43+
hugo: ## for local development
44+
hugo $(BASEURLARG)
45+
46+
# Add help text after each target name starting with '\#\#'
47+
help: ## Show this help.
48+
@echo "\nHelp for this makefile"
49+
@echo "Possible commands are:"
50+
@grep -h "##" $(MAKEFILE_LIST) | grep -v grep | sed -e 's/\(.*\):.*##\(.*\)/ \1: \2/'
51+
@echo
52+
@echo If you have naively forked this repo, say to
53+
@echo github.com://myname/numpy.org.git, you can test out the build via
54+
@echo make TARGET=myname BASEURL=https://myname.github.io/numpy.org deploy
55+

‎README.md‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,17 @@
1-
# Scipy.org Website Source Code
2-
3-
This repository contains the Sphinx source for the [SciPy website](http://www.scipy.org/).
1+
# scipy.org
42

5-
After cloning this repository, run
3+
## Build
64

75
```
8-
$ git submodule init
9-
$ git submodule update
6+
git submodule update --init --recursive
7+
make hugo
108
```
119

12-
to get the Sphinx theme used.
10+
The pages are in `public/`.
1311

14-
The source is in the `www` directory, `cd` there, then the following
15-
commands apply:
16-
17-
To make a local build of the website
18-
19-
`$ cd www`
20-
`$ make html`
21-
22-
To build and upload the site (requires ssh access to www.scipy.org,
23-
and if you're on macOS then upgrade rsync with Homebrew first):
24-
25-
`$ make upload USERNAME=myusername`
26-
27-
To test external links from the site
28-
29-
`$ make linkcheck`
12+
To run the development server, which hosts the site and recompiles
13+
automatically on edits:
3014

15+
```
16+
make serve
17+
```

‎archetypes/default.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: true
5+
---
6+

‎config.yaml‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
baseURL: https://scipy.scientific-python.org/
2+
languageCode: en-us
3+
theme: scientific-python-hugo-theme
4+
disableKinds: ["taxonomyTerm"]
5+
googleAnalytics: UA-162151853-1
6+
DefaultContentLanguage: en
7+
markup:
8+
goldmark:
9+
renderer:
10+
unsafe: true
11+
12+
# Uncomment this to disable the translations for the specified languages.
13+
# This may be useful to be able to merge partial translations without deploying
14+
# them to numpy.org immediately.
15+
disableLanguages: ["pt", "ja"]
16+
17+
params:
18+
images:
19+
- /images/logo.svg
20+
navColor: blue
21+
font:
22+
name: "Lato"
23+
sizes: [400,900]
24+
25+
languages:
26+
en:
27+
title: SciPy
28+
weight: 1
29+
contentDir: content/en
30+
31+
languageName: English
32+
params:
33+
description: Why SciPy? Fundamental algorithms. Broadly applicable. Foundational. Interoperable. Performant. Open source.
34+
navbarlogo:
35+
image: logo.svg
36+
altText: A blue circle with a snake in the shape of the letter 'S'.
37+
link: /
38+
hero:
39+
# Main hero title
40+
title: SciPy
41+
# Hero subtitle (optional)
42+
subtitle: Fundamental algorithms for scientific computing in Python
43+
# Button text
44+
buttontext: Get started
45+
# Where the main hero button links to
46+
buttonlink: "/install"
47+
# Hero image (from static/images/___)
48+
image: logo.svg
49+
# Customizable navbar. For a dropdown, add a "sublinks" list.
50+
news:
51+
title: SciPy 1.7.1 released
52+
content: 2021-08-01
53+
url: /news
54+
55+
#shell:
56+
# title: placeholder
57+
58+
# promptlabel: interactive shell prompt
59+
60+
# button:
61+
# - label: Enables the interactive tutorial shell
62+
# text: Enable
63+
64+
#shellcontent:
65+
# intro:
66+
# - title: Try SciPy
67+
# text: Enable the interactive shell
68+
69+
# loading:
70+
# - title: While we wait...
71+
# text: Launching container on mybinder.org...
72+
73+
# docslink: Don't forget to check out the <a href="https://docs.scipy.org/doc/scipy/reference/" target="_blank">docs</a>.
74+
75+
keyfeatures:
76+
features:
77+
- title: Fundamental algorithms
78+
text: SciPy provides algorithms for optimization, integration, interpolation, eigenvalue problems, algebraic equations, differential equations and many other classes of problems.
79+
- title: Broadly applicable
80+
text: The algorithms and data structures provided by SciPy are broadly applicable across domains.
81+
- title: Foundational
82+
text: Extends NumPy providing additional tools for array computing and provides specialized data structures, such as sparse matrices and k-dimensional trees.
83+
- title: Performant
84+
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.
85+
- title: Easy to use
86+
text: SciPy's high level syntax makes it accessible and productive for programmers from any background or experience level.
87+
- title: Open source
88+
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).
89+
90+
section5: false
91+
92+
93+
navbar:
94+
- title: Install
95+
url: /install
96+
- title: Documentation
97+
url: https://docs.scipy.org/doc/scipy/reference/
98+
- title: Download
99+
url: /download
100+
- title: Mailing Lists
101+
url: /mailing-lists
102+
- title: Report bugs
103+
url: /bug-report
104+
footer:
105+
logo: logo.svg
106+
socialmediatitle: ""
107+
socialmedia:
108+
- link: https://github.com/scipy/scipy
109+
icon: github
110+
quicklinks:
111+
column1:
112+
title: ""
113+
links:
114+
- text: Install
115+
link: /install
116+
- text: Documentation
117+
link: https://docs.scipy.org/doc/scipy/reference/
118+
- text: Citing SciPy
119+
link: /citing-scipy
120+
- text: Roadmap
121+
link: https://docs.scipy.org/doc/scipy/reference/dev/roadmap.html
122+
- text: Donate
123+
link: /donations
124+
column2:
125+
links:
126+
- text: About Us
127+
link: https://docs.scipy.org/doc/scipy/reference/dev/governance/people.html
128+
- text: Code of Conduct
129+
link: http://scipy.github.io/devdocs/dev/conduct/code_of_conduct.html
130+
- text: Developer Zone
131+
link: /dev-zone
132+
- text: Mailing Lists
133+
link: /mailing-lists
134+
- text: FAQ
135+
link: /faq
136+
column3:
137+
links:
138+
- text: Get Help
139+
link: /gethelp
140+
- text: Terms of Use
141+
link: /terms
142+
- text: Privacy
143+
link: /privacy
144+
- text: Press Kit
145+
link: /press-kit

‎content/en/bug-report.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Bug reports
3+
sidebar: false
4+
---
5+
6+
**Please help us by reporting any problems you find.**
7+
8+
NumPy and SciPy libraries make use of GitHub to do project management.
9+
There, you can see what we are currently working on (Pull Requests), as
10+
well as file bug-reports (issues).
11+
12+
1. Go to the relevant page:
13+
- [SciPy library pull
14+
requests](https://github.com/scipy/scipy/pulls)
15+
- [SciPy library bug
16+
reports](https://github.com/scipy/scipy/issues)
17+
- [NumPy library pull
18+
requests](https://github.com/numpy/numpy/pulls)
19+
- [NumPy library bug
20+
reports](https://github.com/numpy/numpy/issues)
21+
2. On GitHub, you need to register an account the first time you use
22+
it.
23+
3. Make sure the bug hasn\'t already been reported. Click on \"Search\"
24+
and type in some keywords to search for.
25+
4. File your bug-report by clicking \"New Issue\" on GitHub. For advice
26+
on how to provide a useful bug report, see the
27+
[guidelines for submitting bugs](#guidelines-for-submitting-bugs).
28+
5. Note that the bug trackers are mostly for actual bugs. If you want
29+
to propose an enhancement, then the mailing list is a better place
30+
to get feedback.
31+
32+
**Thank you for helping to make** SciPy **better!**
33+
34+
# Guidelines for submitting bugs
35+
36+
- Provide a good description. Tickets in the vein of \"SciPy is
37+
BROKEN!!!\" are not useful; rather, please state the problem
38+
clearly, e.g., \"scipy.ndimage ignores keyword \'axis\'\".
39+
40+
- Include a minimal standalone code snippet to illustrate the problem.
41+
Try to narrow it down to a few lines.
42+
43+
- If you experience segfaults or memory errors, give a GDB traceback:
44+
45+
$ gdb python
46+
GNU gdb 6.3.50-20050815 (Apple version gdb-573) (Fri Oct 20 15:50:43 GMT 2006)
47+
Copyright 2004 Free Software Foundation, Inc.
48+
GDB is free software, covered by the GNU General Public License, and you are
49+
welcome to change it and/or distribute copies of it under certain conditions.
50+
Type "show copying" to see the conditions.
51+
There is absolutely no warranty for GDB. Type "show warranty" for details.
52+
This GDB was configured as "i386-apple-darwin"...Reading symbols for shared
53+
libraries .. done
54+
(gdb) run -c "import scipy; scipy.test(10,10)"
55+
Starting program: /usr/local/bin/python -c "import scipy; scipy.test()"
56+
Reading symbols for shared libraries . done
57+
Program received signal SIGTRAP, Trace/breakpoint trap.
58+
0x8fe01010 in __dyld__dyld_start ()
59+
(gdb) c
60+
Continuing.
61+
Reading symbols for shared libraries . done
62+
Reading symbols for shared libraries . done
63+
...
64+
65+
Then use the \"bt\" command after the segfault happens to get the
66+
backtrace. Alternatively, run the code using
67+
[Valgrind](http://valgrind.org/).

0 commit comments

Comments
 (0)