1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-05 18:16:23 +03:00

12 Commits

Author SHA1 Message Date
kgv
7863dabb54 0031002: Documentation - update Overview for 7.4.0
Updated OCC logo.
Replaced some external links to https.
Added references to VS2019 support.
Added glTF, OBJ, IFC, JT into listing within appropriate sections.
Replaced dead URLs.

Fixed misleading information.
2019-09-26 17:01:58 +03:00
ysn
a41ccd91d9 0027018: Documentation - blockquotes are incorrectly formatted in PDF
Trailing space is removed after ">" to avoid breaking the quote block in PDF output.

A section about quotes are added in the documentation guide.
2017-08-24 19:12:57 +03:00
ysn
d6b4d3d0d5 0028654: Existed tool (gendoc) for generation documentation does not take into account size of images.
The parameter defining image width has been added to all figures to improve their layout in PDF documents and tweaked depending on the nature of each image.
Additionally, some minor changes improving image and text layout have been introduced.

Remove temporary added possibility for setting image width automatically for generation of pdf documentation.
2017-06-09 12:59:02 +03:00
kgv
d2e4d7b92d 0028814: Documentation - suggest using # instead of // for temporary comments in commit description 2017-06-09 12:58:58 +03:00
apn
7e3451c7a2 0028347: Reuse OCCT implementation for producing end-user documentation for Products
Updated destination directory for generated by gendoc proc pdf files.

Added additional option "-update_images_size" for gendoc procedure to update width of images in *.md files during pdf generation for @figure alias.

Documentation was updated to use alias @figure instead of outdated @image

Added support of svg image format in procedure OCCDoc_UpdateImagesSize.

Added generation of overview for product components.

Added generation of products refman/chm for each component.
2017-05-05 11:27:56 +03:00
ysn
3f8122493a 0026187: Implement m-dashes in the documentation
- m-dashes added.
- some other cases of incorrect dash use fixed
- unicode dashes were removed throughout the documentation.
- other comments taken into account.
2016-01-28 12:46:59 +03:00
abv
dcc0a33ebd 0024514: Unclear guidelines to report issues in Mantis
Contribution workflow document is revised and extended to eliminate inconsistencies and describe the process in more details:

- Meaning of issue fields in Mantis (Category, Severity, Profile, Project and Target Version, etc.) is described in more details
- Additional rules are defined and examples given for defining Summary and Description, and writing commit messages
- Requirements for testing, creation of test case, update of user documentation, etc. when resolving an issue, are described
- Additional elements of the workflow (patch sumbission, rebasing branches, use of feedback status, issue relationships) are described

Some refinement in other guides; OCC logo updated for better quality.
2015-12-22 15:24:15 +03:00
ysn
f9e256b388 0026425: Update of OCCT contribution workflow
Requirements to the release documentation described in more details.
Added some suggestions concerning the workflow.
Workflow rewritten according to the remarks.
2015-12-22 15:24:03 +03:00
ysn
8d44b0a05f 0025674: Debug dev guide: misprint in Saving and dumping shapes and geometric objects section
Documentation changes and improvements suggested in bugs 25674, 25702 and 25882.
Some corrections for new content in debug.md
2015-03-12 12:14:12 +03:00
omy
ba06f8bbee 0024722: Move functionality of WOK command wgendoc to OCCT tool gendoc
Command gendoc improved to:
- generate Reference Manual documentation (OCCT classes reference) with option -refman; option -overview can be used for generation of overview documentation;
- generate PDF documents for all User Guides automatically (for files listed in FILES_PDF.txt);
- check availability of third-party tools (Doxygen, Inkscape etc.) and properly report warnings and errors.
- use templates of configuration files for third-party tools instead of their generation. These template files are located in dox/resources folder

Tcl scripts are moved from dox folder to adm.
Doxygen warnings are eliminated.
Moved all auxilary functions to occaux.tcl.
Fixed Reference manual generation on *nix platform.
Fixed PDF generation on *nix platforms.
2014-04-10 19:21:16 +04:00
ysn
dd21889ecf 0024336: Content of OCCT documentation should be updated. Iter 2
Minor corrections in documentation (dev guides)

Finalized brep_wp guide (by DLN); entirely removed non-PNG images to provide smooth PDF generation;  Restored cross-guide links in Technical overview; small improvements and editing in GIT guide.

Resized some images to better fit on PDF pages.
2013-11-28 12:18:19 +04:00
ysn
bf62b306ab 0024336: Content of OCCT documentation should be updated. Iter 2
CDL guide finalized.
Brep WP added
Added white-papers and 2 dev guides in the generated documentation structure.
White-papers + 2 developer guides + Draw UG finalized.
Visualization guide finalized.
Fixes for bugs 24205, 23737 and 24021
2013-11-21 13:27:41 +04:00