Skip to content

Custom build scripts #71

Open
Open
@samuel-emrys

Description

@samuel-emrys

I've been looking for a way to add instructions to the build process aside from solely calling sphinx-build. As a C++ developer, my use case for sphinx involves using doxygen/breathe to generate API documentation prior to executing sphinx-build. I notice that you've got some instructions for exhale, which fills a similar role to what breathe does. Unfortunately, to generate an accurate API, both doxygen and breathe need to run prior to sphinx-build to ensure the API documentation is accurate for the branch that's being built. That is, it needs to run on every branch/tag that's being built.

Are you able to advise on whether there's currently a good way of achieving this, and if not, is there a good way to implement this?

My thought is that you could specify a script as an argument to sphinx-multiversion, at which point you allow a user to take full control of the build process. Any additional arguments could be passed to the script which could ignore them or parse them as required, but otherwise the process would depend on the script to make the appropriate sphinx-build calls.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions