Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for Doxygen 1.9.5 #2445

Merged
merged 3 commits into from
Nov 11, 2022
Merged

Updates for Doxygen 1.9.5 #2445

merged 3 commits into from
Nov 11, 2022

Conversation

chrisrichardson
Copy link
Contributor

  • Update Doxyfile
  • Add some fixes for sphinx

@jorgensd
Copy link
Sponsor Member

jorgensd commented Nov 10, 2022

I get some issues building the docs locally:

/root/shared/dolfinx/cpp/doc/source/fem.rst:64: WARNING: Parsing of expression failed. Using fallback parser. Error was:
Error in postfix expression, expected primary expression or type.
If primary expression:
  Invalid C++ declaration: Expected identifier in nested name. [error at 205]
    std::pair< DofMap, std::vector< std::int32_t > > collapse (MPI_Comm comm, const mesh::Topology &topology, const std::function< std::vector< int >(const graph::AdjacencyList< std::int32_t > &)> &reorder_fn=[](const graph::AdjacencyList< std::int32_t > &g) { return graph::reorder_gps(g);}) const
    -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------^
If type:
  Invalid C++ declaration: Expected identifier in nested name. [error at 205]
    std::pair< DofMap, std::vector< std::int32_t > > collapse (MPI_Comm comm, const mesh::Topology &topology, const std::function< std::vector< int >(const graph::AdjacencyList< std::int32_t > &)> &reorder_fn=[](const graph::AdjacencyList< std::int32_t > &g) { return graph::reorder_gps(g);}) const
    -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------^

related to https://github.com/FEniCS/dolfinx/blob/chris/doxygen/cpp/dolfinx/fem/DofMap.h#L144-L146
These issues only happen with the latest sphinx 5.3.0, not with 5.02 which we have pinned to on CI

@jorgensd
Copy link
Sponsor Member

Probably related to sphinx-doc/sphinx#10152

Copy link
Sponsor Member

@jorgensd jorgensd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. See general comment regarding sphinx

@chrisrichardson
Copy link
Contributor Author

I have the same warning with sphinx - but the docs still seem to build OK.

@chrisrichardson chrisrichardson merged commit e9730bb into main Nov 11, 2022
@chrisrichardson chrisrichardson deleted the chris/doxygen branch November 11, 2022 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants