-
Notifications
You must be signed in to change notification settings - Fork 436
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
Add API package allowing integration with the Manual #1039
Comments
This would be a very convenient place for me to hook in for my API doc generator for IDEs (and, possibly, a static website generator). |
Done. Will see if / when / how Lua / component documentation will go into the manual. |
How about tabs (read it somewhere)? |
Are already in :-) |
I'll dig myself into it, let's see what I can figure out. |
Where does the initial file, i.e. index.md get set as the initial? |
Here, why? |
Just looking' for it |
Yeah, I could get started with a new tab and .md files for the LUA api/ methods (like NEI used to be). |
Ah, that's what you mean. I don't think this should be filled out by hand, instead it should be populated from the Main problem being, this may (most likely) need new annotations to properly automate. |
@fnuecke I don't think the full dynamic API documentation should be in the manual, it's just too much... If you wanted to add it, just make a new ContentProvider reading all the EnvironmentAware stuff and putting those into a prefabricated base markdown file being the index listing all the APIs. I don't think you should do that, though. |
Basic should suffice. After getting used to OC and the Manual, most will likely change to 'man' anyway. |
Actually, looking at how MANY drivers there are, dynamic would be A LOT faster (and easier)... |
If this gets added, then yeah, it'll somehow be using the EnvironmentAware stuff, sure. But at the moment that is only available on query when you already have an item to query it for. If it were to be displayed in a list in the manual, we'd somehow have to know which items are relevant and provide said environments. For now, I don't think it has a very high priority, but if API docs go in, when they do it should be automated. |
Stuff to add new tabs, new pages and so on.
The text was updated successfully, but these errors were encountered: