Giter VIP home page Giter VIP logo

Comments (4)

boegel avatar boegel commented on June 17, 2024

Documented procedure by 2011 summer intern (in Dutch):

Eventjes uit mijn bash-history gereconstrueerd:

Mappenconstructie:

easybuild:
 |-- easybuild
 |   |-- build.py
 |   |-- apps
 |   \-- ...
 \-- doc
     |-- conf.py
     |-- Makefile
     \-- index.rst

(Ik weet niet of die laatste 3 in de repo zitten, zie bijlage).

Ik heb een scriptje vanop https://bitbucket.org/etienned/sphinx-autopackage-script gebruikt, maar blijkbaar zit dat tegenwoordig ingebouwd

    sphinx-autopackage-script/generate_modules.py -d doc easybuild -s rst
    cd doc
    PYTHONPATH=.. make html

Hopende u hiermee voldoende geïnformeerd te hebben.

Met vriendelijke groeten,
Pieter De Baets

index.rst

.. EasyBuild documentation master file, created by
   sphinx-quickstart on Tue Aug 30 16:34:10 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to EasyBuild's documentation!
=====================================

Contents:

.. toctree::
  :maxdepth: 4

  easybuild

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

from easybuild-framework.

JensTimmerman avatar JensTimmerman commented on June 17, 2024

This generated documentation should be our 'reference guide' for developers.
see http://blog.parse.com/2012/01/11/designing-great-api-docs/

from easybuild-framework.

boegel avatar boegel commented on June 17, 2024

epydoc seems to be a very good alternative as well, see http://epydoc.sourceforge.net/

from easybuild-framework.

JensTimmerman avatar JensTimmerman commented on June 17, 2024

documentation is generated here:
https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master/Documentation/?

from easybuild-framework.

Related Issues (20)

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.