Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
bob.core
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
bob
bob.core
Commits
78f43953
Commit
78f43953
authored
11 years ago
by
André Anjos
Browse files
Options
Downloads
Patches
Plain Diff
Substantially update the README with instructions
parent
cfc660b3
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+37
-1
37 additions, 1 deletion
README.rst
with
37 additions
and
1 deletion
README.rst
+
37
−
1
View file @
78f43953
...
@@ -15,10 +15,23 @@ Installation
...
@@ -15,10 +15,23 @@ Installation
Install it through normal means, via PyPI or use ``zc.buildout`` to bootstrap
Install it through normal means, via PyPI or use ``zc.buildout`` to bootstrap
the package and run test units.
the package and run test units.
Documentation
-------------
You can generate the documentation for this package, after installation, using
Sphinx::
$ sphinx-build -b html doc sphinx
This shall place in the directory ``sphinx``, the current version for the
documentation of the package.
Testing
Testing
-------
-------
Run the test suite using ``./bin/nosetests``.
You can run a set of tests using the nose test runner::
$ nosetests -sv blitz
.. warning::
.. warning::
...
@@ -28,3 +41,26 @@ Run the test suite using ``./bin/nosetests``.
...
@@ -28,3 +41,26 @@ Run the test suite using ``./bin/nosetests``.
to your working binary. This will cause a stack corruption. Either remove
to your working binary. This will cause a stack corruption. Either remove
the centrally installed version of Bob, or build your own version of Python
the centrally installed version of Bob, or build your own version of Python
in which Bob <= 1.2.1 is not installed.
in which Bob <= 1.2.1 is not installed.
You can run our documentation tests using sphinx itself::
$ sphinx-build -b doctest doc sphinx
You can test overall test coverage with::
$ nosetests --with-coverage --cover-package=xbob.core
The ``coverage`` egg must be installed for this to work properly.
Development
-----------
To develop this package, install using ``zc.buildout``, using the buildout
configuration found on the root of the package:
$ python bootstrap.py
...
$ ./bin/buildout
Tweak the options in ``buildout.cfg`` to disable/enable verbosity and debug
builds.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment