Skip to content

Documentation / Dev #41

@lmoresi

Description

@lmoresi

Some errors in the current documentation:

The documentation links for the API point to the old (github pages) version, not the sphinx API docs. This is now contained in the document itself, so it would be better to explain what the API docs are, link them, and also point out the link in the LH margin.

Underworld Documentation and Examples
In addition to the notebooks in this brief set of examples, there are a number of sources of information on using Underworld3 that you can access:

The Underworld Website / Blog

The API documentation (all the modules and functions and their full sets of arguments) is automatically generated from the source code and uses the same rich markdown content as the notebook help text.

The API documentation (development branch)

The underworld3 GitHub repository is the most active development community for the code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions