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

Use function documentation script #6897

Merged
merged 20 commits into from
Apr 30, 2023
Merged

Use function documentation script #6897

merged 20 commits into from
Apr 30, 2023

Conversation

jonpas
Copy link
Member

@jonpas jonpas commented Mar 26, 2019 •
edited
Loading

When merged this pull request will:

TODO:

  • Fix all the current errors (1)

TODO (can be split to separate PR):

  • Populate and link on wiki
    • Do we keep separate page for this? Where do we put the button to access that page (we'll want to run it for ACEX as well, so 2 buttons)?
    • Do we want to include component functions in their respective framework pages instead, like we do with dependencies? Too much clutter that way?

@jonpas jonpas added this to the Ongoing milestone Mar 26, 2019
@dedmen
Copy link
Contributor

dedmen commented Mar 26, 2019

Argument index 4 does not match listed order
Leaving out unused arguments that are just sent to the function for convenience, not sure if that should warn.
Error: Missing "Example" header section
Do we need examples for private functions? I'm thinking no.

Do we want to include private functions in the public docs?

@jonpas
Copy link
Member Author

jonpas commented Mar 26, 2019 •
edited
Loading

Leaving out unused arguments that are just sent to the function for convenience, not sure if that should warn.

Yes, should be written like so:
* 4: Name <TYPE> (unused)

Do we need examples for private functions? I'm thinking no.

Maybe we can skip that requirement.

Do we want to include private functions in the public docs?

No, and they are already filtered out when generating the docs (without --debug).

@jonpas
Copy link
Member Author

jonpas commented Mar 27, 2019 •
edited
Loading

56 errors left to fix.

CI will fail if errors present.

Private functions are no longer checked (separated debug and lint private options).

@dedmen
Copy link
Contributor

dedmen commented Mar 28, 2019

I'll try to fix atleast some errors on weekend.

@kymckay
Copy link
Member

kymckay commented Mar 28, 2019

From the looks of things, quite a few of them are functions that should be private

@jonpas
Copy link
Member Author

jonpas commented Sep 6, 2019

@dedmen did you do anything on this?

@dedmen
Copy link
Contributor

dedmen commented Sep 12, 2019 •
edited
Loading

I don't even remember this.
There was no PR by me after I made that comment so probably not.

@Dahlgren Dahlgren force-pushed the func-docs-ci branch 3 times, most recently from 2747dc7 to 8f2a125 Compare March 1, 2021 15:56
@jonpas
Copy link
Member Author

jonpas commented Jul 23, 2021

Only 18 errors left!

@jonpas
Copy link
Member Author

jonpas commented Nov 11, 2021

@Dahlgren Please don't force push!

One last error remaining:

Processing... common/functions/fnc_toBitmask.sqf
Error: Malformed argument "N: Booleans "

I think the example in this function is wrong. Or the arguments is wrong and first parameter is actually array.

If former, we should probably just add support for either no number in front of argument or N: .

@jonpas
Flake8 document_functions.py
b5db09d
@jonpas
Fix toBitmask header arguments
a3f159f
@jonpas
Improve function documentation script
6d729ee 
Support starting from root or subfolder
Read component name from script_component.hpp's COMPONENT_BEAUTIFIED for use in generated frontmatter title
Add frontmatter for Jekyll
Specify encoding for file operations
@jonpas
Streamline wiki page titles and split Framework into 2 columns
424e755
@jonpas
Add Functions list page
d45266d
@jonpas
Generate dependencies and document functions in CI - remove committin…
443d77f 
…g bot
@jonpas jonpas temporarily deployed to github-pages April 18, 2023 03:03 — with GitHub Actions Inactive
@jonpas
Copy link
Member Author

jonpas commented Apr 18, 2023

This is finally done!

  • All public headers are now in correct format.
  • New Functions page is on the wiki, similar to ACRE2's but split by component.
  • Function documentation script received some updates (support run from root or subfolder, read COMPONENT_BEAUTIFIED for the wiki page title, frontmatter for Jekyll).
  • Framework and Functions index pages are now split into 2 columns (bye ugly long list).
  • Dependencies List and Documented Functions are now generated in CI before the wiki gets deployed via GitHub Pages, this removes committing changes back to the repository. Pages via GitHub Actions is in Beta.

@jonpas jonpas requested review from PabstMirror and bux April 18, 2023 03:20
@jonpas jonpas merged commit 76e1aaf into master Apr 30, 2023
@jonpas jonpas deleted the func-docs-ci branch April 30, 2023 21:03
@PabstMirror PabstMirror added the ignore-changelog Release Notes: Excluded label Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PabstMirror PabstMirror PabstMirror approved these changes

@bux bux Awaiting requested review from bux

Assignees
No one assigned
Labels
area/tools ignore-changelog Release Notes: Excluded kind/documentation
Projects
None yet
Milestone
Ongoing
Development

Successfully merging this pull request may close these issues.

Add function documentation script to CI
5 participants
@jonpas @dedmen @kymckay @PabstMirror @Dahlgren