Skip to content

Render the core and crawl subpackage front pages in the API reference #101

Description

@mmacy

tools/docs/gen_api_reference.py emits a page only for modules with a non-empty __all__. osrlib/core/__init__.py and osrlib/crawl/__init__.py have none, so the subpackage front pages written in #96 and #97 never reach the site. The crawl one holds the only end-to-end runnable program in its batch (characters, party, adventure, session, EnterDungeon, MoveParty), and a reader on the published reference cannot see it.

The fix is in the generator: emit a page for each layer's package (osrlib.core, osrlib.crawl) rendering the module docstring with members: false, and put it at the top of that layer's section in SUMMARY.md and the index. Adding __all__ to the packages would be the wrong fix, because the package root re-exports nothing by design.

Found during the docstring pass (#87 to #99).

Activity

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

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions