i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Generate developer docs with Sphinx

Browse Source 
An effort was started some time ago to consolidate all internal
documentation in the git tree. However, this was just an accumulation of
files in various formats without any strucutre or way to browse it,
which results in no one even knowing that we have docs here.

This converts most of the files to restructuredtext and uses Sphinx to
generate an HTML browsable user manual (with a table of content and a
first attempt to put things in a global hierarchy).

There are almost no changes to the documentation content in this commit
(some obviously obsolete things were removed). The plan is to get the
toolchain up and running to make these docs easily available, and only
then see about improving the content. We can migrate some things off the
wiki and website, and rework the table of contents to have some more
hierarchy levels because currently it's a bit messy.

Change-Id: I924ac9dc6e753887ab56f18a09bdb0a1e1793bfd
Reviewed-on: https://review.haiku-os.org/c/haiku/+/4370
Reviewed-by: Niels Sascha Reedijk <[email protected]>
This commit is contained in:
Adrien Destugues
2021-08-27 11:41:17 +00:00
committed by Adrien Destugues
parent 7f8195344a
commit a5061ecec5
146 changed files with 10937 additions and 12069 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/develop/file_systems/befs/resources.html
-24
View File
@@ -1,24 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<HEAD>
<TITLE>Resources for the Be File System</TITLE>
</HEAD>
<BODY text="#000000" link="#0000FF" bgcolor="#FFFFFF">
<H1>Resources for the Be File System</H1>
<p>Probably the best resource for a description of the inner workings of BFS is the
book "Practical File System Design with the Be File System" written by Dominic
Giampaolo and published by Morgan Kaufmann Publishers. Although that book is out of
print, it's available at the <A HREF="https://www.haiku-os.org/legacy-docs/practical-file-system-design.pdf">Haiku web site</A>.
<p>If you prefer to see how it works in code, please have a look at <A HREF="https://git.haiku-os.org/haiku/tree/src/add-ons/kernel/file_systems/bfs">Haiku's BFS
implementation</A>.
<p>If you are interested in the Haiku file system API, please refer to its documentation
as part of the Haiku book.
</BODY>
</HTML>
docs/develop/file_systems/befs/resources.rst
+16
View File
@@ -0,0 +1,16 @@
The Be File System
================================
Probably the best resource for a description of the inner workings of
BFS is the book "Practical File System Design with the Be File System"
written by Dominic Giampaolo and published by Morgan Kaufmann
Publishers. Although that book is out of print, it's available at the
`Haiku web
site <https://www.haiku-os.org/legacy-docs/practical-file-system-design.pdf>`__.
If you prefer to see how it works in code, please have a look at
`Haiku's BFS
implementation <https://git.haiku-os.org/haiku/tree/src/add-ons/kernel/file_systems/bfs>`__.
If you are interested in the Haiku file system API, please refer to its
documentation as part of the Haiku book.