Skip to content

Add a "Developer" section in the documentation #64

@OliRom

Description

@OliRom

Currently, the documentation only explains how to install and use the package. However, it lacks information for developers — such as how to run tests, generate the documentation, or build the C++ components.

Here are some topics that should be added to a new "Developer" section:

  • How to run the tests (both Python and C++) with coverage
  • How to generate the documentation
  • How to build the C++ library files used by Python
  • How to benchmark the package and show the results

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions