Skip to content

Commit

Permalink
doc updated for 2.8
Browse files Browse the repository at this point in the history
  • Loading branch information
lesgourg committed Nov 22, 2019
1 parent 1acfdd5 commit 88b9dcf
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ python/build/
RealSpaceInterface/cache/
.DS_Store
doc/manual/html
doc/manual/latex
6 changes: 2 additions & 4 deletions doc/README
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@ CLASS automatic documentation folders

doc/manual/CLASS_MANUAL.pdf

* or you can open the html version (actually nicer) with your browser: just open the file

doc/manual/html/index.html

* the files in doc/input/ are auxiliary files for generating it

* if you wish to update this manual yourself using doxygen, look at instructions in section 6 of CLASS_MANUAL.pdf

* there is also an html version that you can access from the CLASS webpages. The html version used to be distributed together with CLASS, but we removed it because the html directory was too big. If you do wish to get the html source files on your own computer, you just need to recompile the manual with "cd doc/input/; ./make1.sh" (assuming that you have doxygen installed).
2 changes: 1 addition & 1 deletion doc/input/mod.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ and move manually the chapters `"The external Pk mode"` and `"Updating the manua

` . make2.sh`

You should now be able to find the finished pdf in `class/doc/manual/CLASS_MANUAL.pdf`. Finally you can commit the changes to git, but not all the content of `doc/` is necessary: only `doc/README`, `doc/input/`, `doc/manual/CLASS_MANUAL.pdf`, `doc/manual/html/`. This means that before committing you will have to do a: `git add doc/manual/html/`, but NOT a: `git add doc/manual/latex/`!
You should now be able to find the finished pdf in `class/doc/manual/CLASS_MANUAL.pdf`. Finally you can commit the changes to git, but not all the content of `doc/` is necessary: only `doc/README`, `doc/input/` and `doc/manual/CLASS_MANUAL.pdf`. Since version 2.8, we are not committing anymore `doc/manual/html/` because it was too big (and complicating the version history): users only get the PDF manual from git.

As a final comment, doxygen uses two main configuration files: `doxyconf` and `doxygen.sty`, both located in class/doc/input. Changes to these files can dramatically impact the outcome, so any modifications to these files should be done with great care.
Binary file modified doc/manual/CLASS_MANUAL.pdf
Binary file not shown.

0 comments on commit 88b9dcf

Please sign in to comment.