Skip to content

Unclear how to setup a C project using genfiles #3

Open
@oliversheridanmethven

Description

@oliversheridanmethven

I have a project which has the following structure

my_project/
- stuff...
- src/
   - arv/  # <-- A C library with .c and .h files. 
   - pyarv/  # <-- A python binding of the C library, also with .c and .h files. 

I am trying to get all the .c and .h files documented using this tool. I have a draft gen file for makedocstring (which I've converted from my Python version to the C version), but I can't get it up and running as expected. The current state of my code can be found here: oliversheridanmethven/pyarv#27 (it's a real project, so quite messy and not minimal).

Could you provide some more documentation about how to write a generation script to take the source and header files and glue it all together?

Originally posted by @oliversheridanmethven in #2

Activity

added
docsImprovements or additions to documentation
on Apr 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @pawamoy@oliversheridanmethven

        Issue actions

          Unclear how to setup a C project using genfiles · Issue #3 · mkdocstrings/c