Documentation #848

Feature #861: === Website & Examples ===

Create BornAgain documentation prototype using Sphinx

Added by pospelov almost 6 years ago. Updated over 5 years ago.

Status:ArchivedStart date:22 Oct 2014
Priority:LowDue date:
Assignee:pospelov% Done:

0%

Category:-
Target version:Sprint 25

Description

Investigate
  • automatic generation of matplotlib’s like examples
  • try autodoc over our C++ API
  • try autodoc over Python stubs produced by Pycharm
  • write about IntensityData object as an example
  • Write Documentation hierarchy
  • Investigate screenshots/gallery functionality
  • Write Get it section

History

#1 Updated by pospelov almost 6 years ago

  • Status changed from New to Backlog
  • Assignee set to pospelov
  • Target version set to Sprint 25

#2 Updated by pospelov almost 6 years ago

  • Description updated (diff)
  • Parent task set to #861

#3 Updated by herck almost 6 years ago

  • Status changed from Backlog to Sprint

#4 Updated by pospelov almost 6 years ago

  • Description updated (diff)
  • Status changed from Sprint to Resolved

#5 Updated by herck over 5 years ago

  • Status changed from Resolved to Archived

#6 Updated by wuttke over 5 years ago

  • Priority changed from Normal to Low

Also available in: Atom PDF