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

Add API package allowing integration with the Manual #1039

Closed
Vexatos opened this issue Apr 9, 2015 · 14 comments
Closed

Add API package allowing integration with the Manual #1039

Vexatos opened this issue Apr 9, 2015 · 14 comments

Comments

@Vexatos
Copy link
Contributor

Vexatos commented Apr 9, 2015

Stuff to add new tabs, new pages and so on.

@Pwootage
Copy link
Contributor

Pwootage commented Apr 9, 2015

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).

@fnuecke
Copy link
Member

fnuecke commented Apr 9, 2015

Done. Will see if / when / how Lua / component documentation will go into the manual.

@fnuecke fnuecke closed this as completed Apr 9, 2015
@KJA1582
Copy link
Contributor

KJA1582 commented Apr 9, 2015

How about tabs (read it somewhere)?

@fnuecke
Copy link
Member

fnuecke commented Apr 9, 2015

Are already in :-)

@KJA1582
Copy link
Contributor

KJA1582 commented Apr 9, 2015

I'll dig myself into it, let's see what I can figure out.

@KJA1582
Copy link
Contributor

KJA1582 commented Apr 9, 2015

Where does the initial file, i.e. index.md get set as the initial?

@fnuecke
Copy link
Member

fnuecke commented Apr 9, 2015

Here, why?

@KJA1582
Copy link
Contributor

KJA1582 commented Apr 9, 2015

Just looking' for it

@KJA1582
Copy link
Contributor

KJA1582 commented Apr 9, 2015

Yeah, I could get started with a new tab and .md files for the LUA api/ methods (like NEI used to be).

@fnuecke
Copy link
Member

fnuecke commented Apr 9, 2015

Ah, that's what you mean. I don't think this should be filled out by hand, instead it should be populated from the @Callback docstrings, because otherwise we have duplicate documentation again, which is bad, because it'd definitely go out of sync sooner or later.

Main problem being, this may (most likely) need new annotations to properly automate.

@Vexatos
Copy link
Contributor Author

Vexatos commented Apr 9, 2015

@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.

@KJA1582
Copy link
Contributor

KJA1582 commented Apr 9, 2015

Basic should suffice. After getting used to OC and the Manual, most will likely change to 'man' anyway.

@KJA1582
Copy link
Contributor

KJA1582 commented Apr 9, 2015

Actually, looking at how MANY drivers there are, dynamic would be A LOT faster (and easier)...

@fnuecke
Copy link
Member

fnuecke commented Apr 9, 2015

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.

Sorry, something went wrong.

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

No branches or pull requests

4 participants