Skip to content

fsdocs fails to generate API docs when watching #532

Description

@tomcl

Describe the bug

Running dotnet fsdocs watch should generate a local copy of the documentation in a browser for development. Instead it errors with an XML reader error on the generated API documentation "C:\GitHub\issie\src\Main\bin\Debug\net8.0\Main.xml"

To Reproduce

As above.

Expected behavior

No xml reader error and ability to watch API documentation as well as markdown documentation.

Additional context

The following workaround is fine for documentation dev:

run dotnet fsdocs watch --noapidocs

This will not generate API documentation but will correctly display and watch the rest, allowing development.

Strangely, API documentation is correctly generated by fsdocs using dotnet fsdocs build so the site API documentation is correct. However it is a shame we cannot easily generate a local copy because the Github site is unpleasantly slow.

The bug appears to be in fsdocs .

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