https://github.com/hyperspy/hyperspy-website
HyperSpy website sources
https://github.com/hyperspy/hyperspy-website
Last synced: 5 months ago
JSON representation
HyperSpy website sources
- Host: GitHub
- URL: https://github.com/hyperspy/hyperspy-website
- Owner: hyperspy
- Created: 2011-08-19T08:28:20.000Z (almost 15 years ago)
- Default Branch: main
- Last Pushed: 2025-04-24T17:26:41.000Z (about 1 year ago)
- Last Synced: 2025-05-13T19:33:42.659Z (about 1 year ago)
- Language: Python
- Homepage: https://hyperspy.org
- Size: 3.96 MB
- Stars: 3
- Watchers: 9
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: news/ACMM2020.rst
Awesome Lists containing this project
README
This repository host the source code of the [hyperspy.org](https://hyperspy.org) website. The built website is pushed automatically to the [hyperspy/hyperspy.github.com](https://github.com/hyperspy/hyperspy.github.com) repository.
# Build the website
The website is built using the [Sphinx](https://www.sphinx-doc.org) framework and the [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io).
To install the dependencies in a python environment:
```
pip install -r requirement.txt
```
To build the website
```
make html
```
# Add a news entry
The news entries are managed using the [ABlog](https://ablog.readthedocs.io) Sphinx extension.
- add an entry in the `news` folder
- use the `post` directive