Skip to content

Latest commit

 

History

History
160 lines (108 loc) · 5.08 KB

README.md

File metadata and controls

160 lines (108 loc) · 5.08 KB
Raw

DIPY.ORG

Background

This site makes use of Sphinx and was built upon Bootstrap via the GRG Sphinx theme and PYData Sphinx Theme. We use Github Action to deploy the website and Github Page to host the website.

Index

  • _static: Contains all assets (images, CSS, JS) for Sphinx to look at.
  • _templates: Contains html layout for custom Sphinx design.
  • _build: Contains the generated documentation.
  • sphinxext: Sphinx custom plugins.
  • theory: Diffusion theory + FAQ files.
  • tools: Contains all scripts to generate some parts of the documentation, like the API.
  • posts: Contains all blog posts.

Testing Locally: Doc generation steps:

Installing requirements

To set up your computer to run this site locally, you need to install the various Python packages in the requirements.txt at the top level of this repository.

$ pip install -U -r requirements.txt

Generate all the Documentation

Under Linux and OSX

$ make -C . clean && make -C . html

Under Windows

$ ./make.bat clean
$ ./make.bat html

This will build a collection of html pages under _build/html and you can open the index.html using your browser of choice.

Creating a PR

When you are happy with any changes you have made to the website. We recommend building the website and making sure that everything is building fine. You should see no warnings for the build.

Once you are sure everything is in order, you can send a PR to this repository. If you are unfamiliar with this, please see this guide from GitHub.

PR Review

When a PR is opened, Github Action will create a preview of any content or style changes.

This must pass before the PR will be merged, furthermore, one review is required before a PR can be merged as well.

Creating a Blog Post

Blog posts can be added by creating a new text file in the posts/<current year> directory. The filename must use the following naming convention YEAR-MONTH-DAY-title.{ext} and be written in one of the following formats:

  • RST formatted text, ext=rst,
  • Jupyter notebook, ext=ipynb; (notebooks are converted to RST using the nbsphinx extension)
  • MD formatted text, ext=md,

Please also see the ABlog documentation for more information.

RST

If you write your post in RST formatted text, each file must also contain the following header for Sphinx via Ablog to parse the post properly:

.. post:: <Date>
   :author: <Name>
   :tags: <Tag list with commas>
   :category: <One of the below>

<Title>
=========

or

:blogpost: true
:date: <Date>
:author: <Name>
:category: <One of the below>

<Title>
=========

Jupyter Notebook

When writing posts as Jupyter notebooks, the first cell should be a Markdown cell with the title as a top-level heading (i.e. using a single #) and the second cell should be a raw cell containing the following

.. post:: <Date>
   :author: <Name>
   :tags: <Tag list with commas>
   :category: <One of the below>
   :exclude:

   <Short description of post>

The short description will appear as a preview of your post on the blog page. See the nbsphinx docs for information on making raw notebook cells compatible with Sphinx and RST.

You might have to open the notebook in a text editor and change the "metadata" for the post cell to include the following

   "metadata": {
    "raw_mimetype": "text/restructuredtext"
   },

In theory the alternative rst style and the below markdown style should also work in this cell.

Additionally, Sphinx will automatically add a link to the interactive version of your notebook, hosted on Binder, to the top of your post. If your notebook requires any other dependencies besides SunPy (or its dependencies), they will need to be added to binder/requirements.txt.

Markdown

If you write your post in markdown formatted text, each file must contain the following header for Sphinx via Ablog to parse the post properly:

---
blogpost: true
date: <Date>
author: <Name>
category: <One of the below>
---

# <Title>

Metadata

Please note that the date for the post is different from the way it is written for the blog filename. Since this date is reader-facing, we want month day year e.g., May 14 2056.

The current range of categories we have "officially" are:

  • release
  • update
  • gsoc
  • news
  • tutorial
  • event

Please select the more appropriate one, for many update or news would be enough.

For tags, you can choose what you prefer for your post but please don't use any that are in the categories list.