Skip to content

Commit

Permalink
Rewrite manual in mkdocs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
cgwalters committed Jan 28, 2016
1 parent 32c360b commit 64ebe2b
Show file tree
Hide file tree
Showing 17 changed files with 692 additions and 1,023 deletions.
121 changes: 0 additions & 121 deletions CONTRIBUTING.md

This file was deleted.

1 change: 1 addition & 0 deletions CONTRIBUTING.md
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ versions support extended validation using
However, in order to build from a git clone, you must update the
submodules. If you're packaging OSTree and want a tarball, I
recommend using a "recursive git archive" script. There are several
available online; [this
code](https://git.gnome.org/browse/ostree/tree/packaging/Makefile.dist-packaging#n11)
available online;
[this code](https://git.gnome.org/browse/ostree/tree/packaging/Makefile.dist-packaging#n11)
in OSTree is an example.

Once you have a git clone or recursive archive, building is the
Expand Down
5 changes: 0 additions & 5 deletions apidoc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,6 @@ HTML_IMAGES=
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files= \
overview.xml \
repo.xml \
deployment.xml \
atomic-upgrades.xml \
adapting-existing.xml \
$(NULL)

# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
Expand Down
Loading

0 comments on commit 64ebe2b

Please sign in to comment.