offline NoAI API documentation?

[Lord Aro]

since my computer is regularly offline (cable across the house, am working on getting wireless)
i was wondering if there was a way to download the whole API documentation
e.g. download the whole of http://noai.openttd.org/docs/trunk
maybe?

[Alberth]

As part of pulling the latest changes from trunk, I compile the sources, and build documentation with doxygen at my local machine.
It may not look as pretty as the site, but all info is there.

[Kogut]

Or manually saving all pages.

[Lord Aro]

As part of pulling the latest changes from trunk, I compile the sources, and build documentation with doxygen at my local machine.
It may not look as pretty as the site, but all info is there.

i like that idea better than Kogut's (obvious really )
how would i do this?

[Alberth]

1. install Doxygen
2. download trunk from svn, hg, or git.
3. run 'doxygen Doxyfile'

the next time, you can just update your working copy ('svn up' or 'hg fetch') instead of doing 2 again.

Edit: You should download the source code of the version that you use for making AIs. For stables, you could download its source code distribution.

[tracks]

I noticed that the "docs" option on the download page includes reasonable doxygen. But is this the same as what's online for the NoAI documentation? Looks like it includes far more code (ie. the rest of the code base), but it does have the AI functions in there. But maybe this is for the underlying implementation of the API and may be different from what's present in the squirrel interface?

[frosch]

The docs which can be downloaded at http://www.openttd.org/download-trunk ("docs" is an option for the OS selection) contain the whole documentation of OTTD. It also contains the NoAI documentation, though not in an as nice format as the pure NoAI documentation, as it also contains lots of references to not-NoAI stuff. If you want to use that one, go via File List and select stuff from src/ai/api.

If you want to build the documentation yourself, insert a "cd src/ai/api" between step 2 and 3 of Albert. That gives you the pure NoAI documentation, else you will get what you can also download above

[skippern]

Is there anywhere available a .PDF version of the NoAI API documentation, that can be downloaded or emailed to me, or do anybody have time (and resources) to create such?

I am trying to work on some AI's but are sitting on an unstable sattelite line, and the company computer with access to internet don't have any print2pdf software.

And why is the documentation on http://www.openttd.org/en/download-trunk only available in .xz format? No .zip?

[planetmaker]

And why is the documentation on http://www.openttd.org/en/download-trunk only available in .xz format? No .zip?

Bandwidth. xz is considerably smaller than zip. And any decent packing programme can handle them.

[skippern]

And why is the documentation on http://www.openttd.org/en/download-trunk only available in .xz format? No .zip?

Bandwidth. xz is considerably smaller than zip. And any decent packing programme can handle them.

Arguments good enough for my own computer, but since I have to go past the work computer (and all my bloody pen-drives decided to die on me), I need to upack and read on that. With installation restrictions I cannot ask for any descent packing programs, for the same reason that I cannot do print2pdf (on my personal computer I can do that, but again, staying offline due to network restrictions). There are roughly 1.5 month until I can try downloading anything to my personal computer. So basically without any .zip, .pdf or similar formats for the documentation I am 1.5 months away of getting offline documentation. With unstable internet connection, that means I can be really stuck from time to time, not being able to check out what I am doing wrong, what arguments are required, what the actual syntax is, etc. I find that really frustrating when I am working on a project.

[R2dical]

I make my own offline docs from doxygen, here is a copy. Just open "index.html" for the main page.

[skippern]

I make my own offline docs from doxygen, here is a copy. Just open "index.html" for the main page.

Great, thanks R2dical!