Giter VIP home page Giter VIP logo

stdlib-docs's Introduction

Stlib documentation

pages

Repository for building the documentation pages for the Fortran standard library (stdlib).

Getting started

Get the code

git clone https://github.com/awvwgk/stdlib-docs
cd stdlib-docs

Install dependencies

The documentation pages are created using sphinx. You first need to install the required dependencies using conda or pip. This project uses

conda

conda env create -n sphinx -f environment.yaml
conda activate sphinx

pip

python3 -m venv venv
source venv/bin/activate
pip install -U pip
pip install -r requirements.txt

Build stdlib-docs

Build the documentation by invoking

make html

The website will be built in _build/html and can be previewed by opening the page with a browser (e.g. firefox, chromium or similar):

firefox file://$PWD/_build/html/index.html

By default all languages will be built. To limit the build to a single language subtree, i.e. English, use

make html LANGUAGES=en

stdlib-docs's People

Contributors

awvwgk avatar jvdp1 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

jvdp1 zoziha

stdlib-docs's Issues

More recipes for how-to section

The how-to section needs more recipes for using stdlib:

Basic installation instructions:

  • buildings stdlib from source via CMake (mainly for contributors/developers)
  • install stdlib from distribution channels, like conda-forge
  • use stdlib via fpm

Problems solved by stdlib

  • converting integer/real values to strings with to_string
  • reading and writing npy files
  • sorting and searching a list of strings
  • reading a whole file into a string or list of strings
  • working on bytes or bitarrays using the bitsets types (instead of unsigned arithmetic)

General design

Currently this is mostly copied from the fpm docs and therefore might look to similar, instead we should aim to make the two documentations visually somewhat distinct.

Things to consider

  • different color scheme
  • logo draft needs some thoughts

Tutorials on stdlib modules

For the tutorials we need self-contained examples which walk the reader through the available functionality and different usage patterns of stdlib. Potential topic are

  • statistics, distributions
  • string processing, input/output
  • quadrature, mathematical utilities

We can have more than one tutorial for a module, if they have several difficulty levels or explore different applications.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.