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.

Sign up for GitHub

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

Tutorials do not consider directory hierarchy #552

Closed
valentinMachado opened this issue Mar 6, 2023 · 1 comment · Fixed by #624
Closed

Tutorials do not consider directory hierarchy #552

valentinMachado opened this issue Mar 6, 2023 · 1 comment · Fixed by #624
Labels
clean up Code has to be modifed but not functionally documentation

Comments

@valentinMachado
Copy link
Contributor

Static doc files in docs/static are all put together in the html result of jsdoc side by side.
We are loosing informations of to who the doc is meant.

Check in https://jsdoc.app/about-tutorials.html if there is a way to solve this, or we could rename files according where they belong in the directory hierarchy.
@valentinMachado valentinMachado added clean up Code has to be modifed but not functionally documentation labels Mar 6, 2023
@valentinMachado
Copy link
Contributor Author

valentinMachado commented Mar 13, 2023 •
edited
Loading

In addition, today some .md in tutorial have the same name and only one is generated => rename all .md with an unique name

@valentinMachado valentinMachado mentioned this issue Mar 14, 2023
Open
This was referenced Apr 21, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
clean up Code has to be modifed but not functionally documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

623 add ci travis only jsdoc generation doc VCityTeam/UD-Viz
1 participant
@valentinMachado