Comments you submit will be routed for moderation. If you have an account, please log in first.

Ticket #3942 (assigned defect)

Opened 10 years ago

Last modified 8 years ago

Fix Acro project documentation

Reported by: jdsiiro Owned by: jdsiiro
Priority: normal Milestone: Acro 2.1
Component: Acro Projects Version: acro 1.0.2
Keywords: Cc:
Subcomponent: Documentation and Web Pages

Description (last modified by wehart) (diff)

Currently, the documentation in svn does not build. While this is really an issue with every subpackage, this really applies to *every* package within Acro - hence filing the bug against Acro.

Main issues:

a) we need to overhaul the organization of the documentation. We should avoid having files that are edited/generated by the build system checked into the repository.

b) we should do our best to avoid copying files around the repository. Renaming them is even more problematic (e.g. utilib's userman.tex is copied from refman.tex).

c) the LaTeX documentation is full of bugs, and in particular, the misuse of the \doxyref command, an incomplete {my}doxygen.sty file, and \tt outside it's scoping {}'s.

d) utilib, colin, and coliny all use slightly different configurations for their documentation

e) currently, sacache's configure doesn't convert doc/ -> Makefile, so "make docs" from the top-level Acro directory doesn't work.


Change History

comment:1 Changed 10 years ago by wehart

  • Status changed from new to assigned
  • Version changed from 1.0 to acro 1.0.2
  • Description modified (diff)
  • Milestone set to acro 2.0

comment:2 Changed 10 years ago by jdsiiro

  • Priority changed from high to normal
  • severity normal deleted

Converting all severities into priorities and deprecating the severity field.

comment:3 Changed 9 years ago by wehart

  • Milestone changed from acro 2.0 to acro 2.1

comment:4 Changed 9 years ago by wehart

  • Milestone acro 2.1 deleted

comment:5 Changed 8 years ago by jdsiiro

  • Owner changed from wehart to jdsiiro
  • Milestone set to Acro 2.1

Add a comment

Modify Ticket

Change Properties
<Author field>
as assigned

E-mail address and user name can be saved in the Preferences.

Note: See TracTickets for help on using tickets.