search

ENZYME-APD / tapir-archicad-automation

The easiest way to use the JSON/Python API from Archicad without knowing how to code.
MIT License
57 stars 17 forks source link

Command to generate documentation files automatically. #167

Closed kovacsv closed 3 months ago

kovacsv commented 3 months ago

Available from the shiny new Tapir menu in Archicad.

kovacsv commented 3 months ago

@tlorantfy can you review this please?

tlorantfy commented 3 months ago

@kovacsv , thanks, it makes our life easier! But how do you plan to use this generation menu? I mean this must be done manually and somebody has to upload the generated documentation when releasing new version, right?

I've just realized that you haven't removed those js files from repo. So if I understand it correctly, when I finished a new command, then I need to generate those 2 js files using this menu before creating the pull request (and do not have to edit them manually). Roger that, cool!

What happens if there is a command which exists in AC27 only and I generate the docs using AC26 (that's the only version I have). In that case the docs will missing that command, right? I believe we should stop creating commands like that. Currently HighlightElementsCommand is the only one which does not exist in all supported AC versions. I think all commands must exist in all versions and if one is not working in a version then its Execute should return error. What do you think? If you agree I will modify HighlightElementsCommand like that.

kovacsv commented 3 months ago

@kovacsv , thanks, it makes our life easier!

But how do you plan to use this generation menu?

I mean this must be done manually and somebody has to upload the generated documentation when releasing new version, right?

The process is the same, just not manual now. It was a pain updating it. 😅

kovacsv commented 3 months ago

@kovacsv , thanks, it makes our life easier! But how do you plan to use this generation menu? I mean this must be done manually and somebody has to upload the generated documentation when releasing new version, right?

I've just realized that you haven't removed those js files from repo.

So if I understand it correctly, when I finished a new command, then I need to generate those 2 js files using this menu before creating the pull request (and do not have to edit them manually). Roger that, cool!

What happens if there is a command which exists in AC27 only and I generate the docs using AC26 (that's the only version I have). In that case the docs will missing that command, right?

I believe we should stop creating commands like that. Currently HighlightElementsCommand is the only one which does not exist in all supported AC versions. I think all commands must exist in all versions and if one is not working in a version then its Execute should return error. What do you think?

If you agree I will modify HighlightElementsCommand like that.

Great idea, let's do it!