Comments (4)
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.
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.
epydoc
seems to be a very good alternative as well, see http://epydoc.sourceforge.net/
from easybuild-framework.
documentation is generated here:
https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master/Documentation/?
from easybuild-framework.
Related Issues (20)
- make "commit" an optional parameter and template
- GNU_SOURCE (https://ftpmirror.gnu.org/gnu/) downloads failing HOT 2
- Packaging with read-only install directory crashes with `Permission denied`
- make `--job` a bit smarter when uploading test reports HOT 2
- Create an option for a developer mode HOT 3
- Change default value for module-extensions to True
- Change default value for module-depends-on to True
- Feature request/proposal: maintainers/authors optional infos in easybuild files HOT 1
- Honor dependency order when (re)building multiple ECs HOT 4
- Checksum should be allowed to be a single dictionary at the top level scope only, even for bundles/extensions (where there are top level sources as well)
- More granular `eb` exit codes (return codes) HOT 3
- Clean up SLURM/Batchsystem environment before doing builds HOT 4
- PR title created with --new-pr misses 2nd toolchain HOT 2
- Accepting EULA in a container recipe HOT 1
- Download instructions should tell user exactly what files to put where HOT 2
- `eb` command fails outside of framework source folder HOT 4
- Auto-enable Fortran oneAPI compilers HOT 1
- Add option to ignore default config files
- refactor easyconfig parameters and template constants to use a consistent naming style HOT 9
- Add `sysroot` support to intel compilers
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from easybuild-framework.