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

[docs] Update documentation structure with markdown files #1300

Merged
merged 9 commits into from
Nov 17, 2022

Conversation

mugulmd
Copy link
Contributor

@mugulmd mugulmd commented Nov 14, 2022

Description

This PR aims at updating the project documentation on several levels:

  • with a new doxygen setup to build a HTML documentation of the C++ code
  • with a new README.md file in several sub-directories of the aliceVision directory so that users can quickly understand how the module is structured and how to use it
  • with a BIBLIOGRAPHY.md file to store the project bibliography.

@mugulmd mugulmd self-assigned this Nov 14, 2022
@mugulmd mugulmd marked this pull request as ready for review November 14, 2022 10:34
@fabiencastan fabiencastan added this to the 2.5.0 milestone Nov 17, 2022
@fabiencastan fabiencastan changed the title [docs] Update documentation [docs] Update documentation structure with markdown files Nov 17, 2022
@fabiencastan fabiencastan merged commit fba6d0f into develop Nov 17, 2022
@fabiencastan fabiencastan deleted the mug/doxygenSetup branch November 17, 2022 22:42
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.

3 participants