ostree

Commit Graph

Author	SHA1	Message	Date
Mathnerd314	1b88dc7f90	docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters	2016-06-09 18:15:49 +00:00
Colin Walters	64ebe2b82a	Rewrite manual in mkdocs I don't much like Docbook (and am considering converting the man pages too), but let's start with the manual. I looked at various documentation generators (there are a lot), and I had a few requirements: - Markdown - Packaged in Fedora - Suitable for upload to a static webserver `mkdocs` seems to fit the bill.	2016-01-28 09:31:37 -05:00
Colin Walters	32c360b5a0	build: Rename doc/ -> apidoc/ This is preparation for introducing a `mkdocs` manual under `doc/` which should be significantly more useful for the world at large than the minimal manual that exists there now.	2016-01-28 09:31:34 -05:00

Author

SHA1

Message

Date

Mathnerd314

1b88dc7f90

docs: Get API docs working again

This changes around a few things that didn't work for me:
* Section names seem to be ostree-* instead of libostree-*
* Also XML files are ostree-* (they didn't show up at all)
- gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly
* pull documentation is now on the actual functions rather than stubs
* Update gitignore with some more files

And there some changes to make gtk-doc give fewer warnings (not finished)

Closes: #327
Approved by: cgwalters

2016-06-09 18:15:49 +00:00

Colin Walters

64ebe2b82a

Rewrite manual in mkdocs

I don't much like Docbook (and am considering converting the man pages
too), but let's start with the manual.

I looked at various documentation generators (there are a lot), and
I had a few requirements:

 - Markdown
 - Packaged in Fedora
 - Suitable for upload to a static webserver

`mkdocs` seems to fit the bill.

2016-01-28 09:31:37 -05:00

Colin Walters

32c360b5a0

build: Rename doc/ -> apidoc/

This is preparation for introducing a `mkdocs` manual under `doc/`
which should be significantly more useful for the world at large than
the minimal manual that exists there now.

2016-01-28 09:31:34 -05:00

3 Commits