Docs overhaul

Merged
#180 · Created  · Last updated

Merged pull request

Merged in docs_overhaul (pull request #180)

2ec8068·Author: ·Closed by: ·2018-07-23

Description

This is a pretty thorough overhaul of the documentation. Fixed lots of errors, standardized some style, added missing arguments/types, etc. Some modules could still use some love from their authors or someone with more specific knowledge of the topic, but for now this suffices to make the docs both readable and useful.

  • Remove incorrect install instructions

  • Update intro with installation instructions, support information, and a better introduction

  • Update installation instructions

  • Update bond docstrings

  • Update box

  • Update cluster

  • Update density

  • Update index

  • Update interface

  • Update kspace

  • Update locality

  • Update order

  • Add environment to docs

  • Update parallel

  • Update pmft

  • Update voronoi

  • Reduce duplication in docs

  • Switch bond.pxi to Google style from reST

  • Switch box.pxi to Google style from reST

  • Updated instructions to use conda-forge.

  • Fixed other installation instructions.

  • Removed parallelism from instructions. Users can provide that flag on their own.

  • Fix minor issues

  • Move module docstrings to modules

  • Remove as much as possible from rst files

  • Switch cluster.pxi to Google style from reST

  • Fix constructor docstring

  • Fix box constructor

  • Fix docs errors

  • Switch density.pxi to Google style from reST

  • Switch environment.pxi to Google style from reST

  • Switch index.pxi to Google style from reST

  • Switch interface.pxi to Google style from reST

  • Switch kspace.pxi to Google style from reST

  • Get rid of empty Args and Returns

  • Switch locality.pxi to Google style from reST

  • Switch order.pxi to Google style from reST

  • Switch parallel.pxi to Google style from reST

  • Switch pmft.pxi to Google style from reST

  • Switch voronoi.pxi to Google style from reST

  • Fix numpy class docs

  • Standardize attribute and optional argument documentation styles

  • Fix all obvious errors

  • Add fsph to license

 

0 attachments

0 comments

Loading commits...