Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update manuals #154

Closed
guyer opened this issue Sep 19, 2014 · 11 comments
Closed

Update manuals #154

guyer opened this issue Sep 19, 2014 · 11 comments

Comments

@guyer
Copy link
Member

guyer commented Sep 19, 2014

Updated manuals need to be generated immediately before release

Imported from trac ticket #169, created by guyer on 11-21-2008 at 10:22, last modified: 02-09-2009 at 16:53

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

  • PDF TOC doesn't go as deep when built on dogbert vs. benson
    • Image layout on examples.cahnHilliardmesh2D is bad

Trac comment by guyer on 01-22-2009 at 17:38

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

  • Massive lists of variables in level set examples (due to introspection) look bad

Trac comment by guyer on 01-22-2009 at 17:39

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Replying to guyer:

  • Image layout on examples.cahnHilliardmesh2D is bad

Fixed the image layout and added the sphere example.

Trac comment by guyer on 01-27-2009 at 17:02

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Replying to guyer:

  • Massive lists of variables in level set examples (due to introspection) look bad

Added an __all__ element to keep from exporting all of FiPy's symbols (r2982)

Trac comment by guyer on 01-27-2009 at 17:03

@wd15
Copy link
Contributor

wd15 commented Sep 19, 2014

Things left to do

  • Possibly remove references to cache and no-cache as they are no longer tested.
  • Possibly remove references to STABLE and CURRENT tags, only give an example using trunk or a particular version

Trac comment by wd15 on 02-03-2009 at 16:00

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Replying to wd15:

  • Possibly remove references to STABLE and CURRENT tags, only give an example using trunk or a particular version

Tags removed (with note added about why they're gone and how to switch a working copy)

Trac comment by guyer on 02-06-2009 at 14:35

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Replying to guyer:

  • Massive lists of variables in level set examples (due to introspection) look bad

Massive lists of variables gone (used an __all__ declaration in the offending examples; probably more places where this should be done).

Trac comment by guyer on 02-06-2009 at 14:36

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Replying to guyer:

  • PDF TOC doesn't go as deep when built on dogbert vs. benson

Filed as issue #168

Trac comment by guyer on 02-06-2009 at 14:43

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Replying to wd15:

  • Possibly remove references to cache and no-cache as they are no longer tested.

References removed.

Trac comment by guyer on 02-06-2009 at 14:45

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Replying to guyer:

  • PDF TOC doesn't go as deep when built on dogbert vs. benson

dogbert was doing what it was supposed to (matching the printed ToC). hyperref supports a bookmarksdepth option, which I now use to achieve the desired appearance.

Trac comment by guyer on 02-09-2009 at 16:35

@guyer
Copy link
Member Author

guyer commented Sep 19, 2014

Manuals are built.

Trac comment by guyer on 02-09-2009 at 16:53

@guyer guyer closed this as completed Sep 19, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants