FABLib Docs

[Paul Ruth]

We have added Sphinx documentation for the FABLib API

The following learn article has more information: https://learn.fabric-testbed.net/knowledge-base/fablib-api/

Paul

[Fraida Fund]

How stable is this API? Should we expect lots of changes in the near future, or not too much?

[Paul Ruth]

This will be as stable as we can make it. The idea is that this is our long-term user-facing API that can hide any changes in the underlying control framework.

There will likely be a lot of additions to the API but our goal is to keep existing features as stable as possible. If/when we find a feature that must be changed, we will try to keep a deprecated version around for a while in parallel to the updated feature.

Feel free to write applications against this API and suggest any additions/changes.

thanks,
Paul

[yoursunny]

The example parallel_config introduces a function Node.execute_thread but it’s not shown in the generated documentation.

Maybe it needs to be re-generated?

[yoursunny]

I just noticed this:

Since FABLib v1.4, API documentation is hosted at https://fabric-fablib.readthedocs.io/.
Older version of FABLib API documentation is at https://learn.fabric-testbed.net/docs/fablib/fablib.html.

Can you add a note on top of the “older version” page, pointing to the v1.4 docs?
I have bookmarked the “older version” page previously, and have been wondering why it doesn’t update, until now.
I suppose some others may have done the same.

[Paul Ruth]

Thanks we will look into this.

We are still in the process of automating the generation of the documentation.

[Author]

Posts