Difference between revisions of "FPCDocs Tutorial"

From Lazarus wiki
(Started fpcdocs page)
 
(category)
Line 26: Line 26:
 
== Generating documentation ==
 
== Generating documentation ==
 
write me ;)
 
write me ;)
 +
 
== References ==
 
== References ==
  
* [1] [[Installing_Lazarus]]
+
* [1] [[Installing Lazarus]]
 
* [2] Build FAQ
 
* [2] Build FAQ
 
* [3] FPDoc manual
 
* [3] FPDoc manual
  
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]
 +
[[Category:Help and Docs]]

Revision as of 08:49, 18 May 2012

Overview

This tutorial will guide you through getting the latest FreePascal docs sources and generating documentation from it. Please see the official documentation [3] for more details.

November 2011: I'm having trouble generating docs, and finding documentation on it, so I decided to start this page to help me and others. Please feel free to update/add info (and remove this notice when it actually works ;) --BigChimp 05:11, 22 November 2011 (CET)

Prerequisites

  • A working FreePascal environment must be installed (e.g. a stable version from a Debian repository). See [1] for more details.
  • Having a working Lazarus installed may not hurt
  • As the documentation needs FPC source files, you will need the latest source from subversion. See [1] on how to get that.
  • Some tex programs: texlive, tex4ht, and dvi2tty if you want to generate plain-text documents (for DOS, mainly). The package names may differ depending on your distribution.

Assumptions

I'm assuming you're running on Linux; apparently generating docs on Windows is not supported. Also, this tutorial assumes you have a stable system-wide installation of FPC and Lazarus, and a working SVN version of FPC with proper fpc.cfg. Finally, you have your SVN FPC source and fpcdocs directories set up like this: <bash> ~/fpc/ ~/fpc/bin/ #contains your installed compiler executables ~/fpc/source/ #contains SVN source code ~/fpc/source/fpcdocs/ #contains SVN fpcocs </bash>


Generating documentation

write me ;)

References