Skip to content

History / WritingDocumentation

Edit page New page

Revisions

  • link to theme colors

    @orbeckst orbeckst committed Jul 8, 2020
    1460119

  • guidelines on annotating change

    @orbeckst orbeckst committed Jun 15, 2020
    d104ffe

  • added code block language hints

    @orbeckst orbeckst committed Apr 2, 2019
    2df0f72

  • replaced NUMPY DOC HOWTO with updated link https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard

    @orbeckst orbeckst committed Sep 12, 2018
    ebd0e72

  • Updated WritingDocumentation (markdown)

    @zemanj zemanj committed Aug 21, 2018
    c1c1949

  • list error messages that are encountered when doing math without raw strings

    @orbeckst orbeckst committed May 24, 2018
    ca87fc7

  • updated http to SSL protocol for docs.mdanalysis.org; also updated release doc procedure (no more pypi)

    @orbeckst orbeckst committed Dec 13, 2017
    95bfaf6

  • Remove old pythonhosted.org link

    @mimischi mimischi committed Dec 13, 2017
    e37e4f4

  • Updated WritingDocumentation (markdown)

    @kain88-de kain88-de committed Nov 10, 2017
    034d319

  • Updated WritingDocumentation (markdown)

    @kain88-de kain88-de committed Apr 17, 2017
    811b2ba

  • Updated to warn about python2 vs 3 sphinx problems.

    @mnmelo mnmelo committed Nov 23, 2016
    72e0296

  • link to NumPy style doc strings

    @orbeckst orbeckst committed Jul 8, 2016
    dc85e1b

  • clean up and removal of outdated content: moved proposed New Doc Guidelines to own page and removed anything on manually building developer docs (see #386 for the new procedure)

    @orbeckst orbeckst committed Nov 18, 2015
    2ff7078

  • updated links to sources on GitHub Note that the links were also updated in release notes etc, i.e. they are now pointing to the most reason versions of the files. It was too much work to make them point to the correct commits. perl -wpi~ -e 's(http://code.google.com/p/mdanalysis/source/browse/package#package%2Fexamples)(https://github.com/MDAnalysis/mdanalysis/tree/develop/package/examples)g' *md perl -wpi~ -e 's(http://code.google.com/p/mdanalysis/source/browse/#git%2Fpackage%2Fexamples)(https://github.com/MDAnalysis/mdanalysis/tree/develop/package/examples)g' *md perl -wpi~ -e 's(http://code.google.com/p/mdanalysis/source/browse/#git%2Fpackage%2Fdoc%2Fsphinx%2Fsource%2Fdocumentation_pages)(https://github.com/MDAnalysis/mdanalysis/tree/develop/package/doc/sphinx/source/documentation_pages)g' *md perl -wpi~ -e 's(http://code.google.com/p/mdanalysis/source/browse/#git%2Fpackage%2FMDAnalysis%2Fanalysis)(https://github.com/MDAnalysis/mdanalysis/tree/develop/package/MDAnalysis/analysis)g' *.md perl -wpi~ -e 's(http://code.google.com/p/mdanalysis/source/browse/)(https://github.com/MDAnalysis/mdanalysis/)g' *.md

    @orbeckst orbeckst committed Sep 26, 2015
    1c5429b

  • updated links to developer docs perl -wpi~ -e 's(http://mdanalysis.googlecode.com/git-history/develop/package/doc/html)(http://devdocs.mdanalysis.org)g' *.md

    @orbeckst orbeckst committed Sep 26, 2015
    6ef40bc

  • updated links to docs perl -wpi~ -e 's(https?://mdanalysis.googlecode.com/git/doc/html)(http://docs.mdanalysis.org)g' *.md perl -wpi~ -e 's(https?://mdanalysis.googlecode.com/git/package/doc/html)(http://docs.mdanalysis.org)g' *md

    @orbeckst orbeckst committed Sep 26, 2015
    94a4c86

  • How-to build and distribute the docs with sphinx

    @orbeckst orbeckst committed Jul 9, 2015
    36117da

  • `MDAnalysis.Universe ?` does not work in ipython for sure

    @hainm hainm committed May 22, 2015
    0f4614e

  • updated links in serving docs

    @orbeckst orbeckst committed May 22, 2015
    210f7cd

  • updated procedure for dev docs

    @orbeckst orbeckst committed May 22, 2015
    adf512b

  • -MDAnalysis wiki doc changes: -updated some of the simpler google code issue links to the new github / subdomain URL format for the issue tracker

    @tylerjereddy tylerjereddy committed May 5, 2015
    e066004

  • ../finishGoogleCodeGitHubWikiMigration/finishGoogleCodeGitHubWikiMigration: Moved pages from mdanalysis wiki branch to mdanalysis.wiki master branch.

    @orbeckst orbeckst committed Apr 5, 2015
    c044f52