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

More documentation generation improvements #45

Merged
merged 3 commits into from
Feb 16, 2024

Conversation

robotboy655
Copy link
Contributor

My previous 2 PRs revealed an issue with library documentation where the timer library could get marked as deprecated because one of its members is deprecated. This PR addresses this, as well provides a number of other improvements:
List of changes:

  • Automatically write out table enum globals and write their descriptions
  • Write descriptions of panel classes and structs
  • Scrape library and class definition pages, write their inheritance and descriptions, etc.
    • This required a pretty large change to how the API documentation files are written. We now keep them in memory until fetching every wiki page is done. This is necessary to ensure the library and class declarations appear first in a file. It should be fine as the total size of the output files takes up about 3MB
  • Output some time statistics to wiki scraping, for comparisons between runs

If there's something needs changing to get this merged, let me know and I will see what I can do.

Fixes #44 (Avoids the issue of class override case sensitivity thing mentioned in previous PR)

Also trim description whitespace
Results in nice and correct library/class descriptions, as well as reduces reliance on hardcoding class inheritance
@luttje
Copy link
Owner

luttje commented Feb 16, 2024

Thanks for your continued improvements to this project, this improvement is a great one again. Not having to custom write parts of the documentation in this project is a plus, the wiki should be the one source of truth.

I'll test this right away and then merge your PR. I'll fix the broken tests myself on main afterwards. Brb

@luttje luttje merged commit b0c5aac into luttje:main Feb 16, 2024
1 check failed
@luttje
Copy link
Owner

luttje commented Feb 16, 2024

Merge completed, tests fixed on main.

No big problems with your code from what I could tell. I tested completion in a project of mine and everything seemed in order.

Thanks again

@robotboy655 robotboy655 deleted the documentation-improvements branch March 16, 2024 03:26
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.

Automatic ENUM globals + better windows handling
2 participants