Skip to content

/ units

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

Jump to bottom

Help fix the documentation generation toolchain #167

Open
mpusz opened this issue Sep 16, 2020 · 1 comment
Open

Help fix the documentation generation toolchain #167

mpusz opened this issue Sep 16, 2020 · 1 comment
Labels
documentation good first issue help wanted
Projects
Issues Kanban Board

Comments

@mpusz
Copy link
Owner

@mpusz mpusz commented Sep 16, 2020

There are many Modern C++ and C++20 related errors during the documentation generation process. I had to disable logs and warnings with -Q in Sphinx because Travis CI was complaining about too long build log and was terminating the build:

units/docs/CMakeLists.txt

Line 69 in cb86cd2

"${SPHINX_EXECUTABLE}" -b html -j auto -Q "-Dbreathe_projects.mp-units=${DOXYGEN_OUTPUT_DIR}/xml" "${SPHINX_SOURCE}" "${SPHINX_BUILD}"

There are problems with:

  • doxygen (both reported by the tool and silent problems evident in the generated XML output)
  • sphinx
  • breathe

We need to identify the source of the problems and report bugs for the respective tool.
@mpusz mpusz added this to the v0.7.0 milestone Sep 16, 2020
@mpusz mpusz added this to To do in Issues Kanban Board via automation Sep 16, 2020
@mpusz mpusz changed the title Help fix documentation generation toolchain Help fix the documentation generation toolchain Sep 16, 2020
@mpusz
Copy link
Owner Author

@mpusz mpusz commented Sep 16, 2020 •
edited

Some issues to follow:
@mpusz mpusz mentioned this issue Mar 9, 2021
Closed
@mpusz mpusz removed this from the v0.7.0 milestone May 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue help wanted
Projects
Issues Kanban Board
  
To do
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
@mpusz