0027191: Documentation - redesign of information architecture -- renaming (3)
Move guides on documentation, tests, coding rules, contribution workflow to dox/contribution
@ -37,12 +37,12 @@ user_guides/inspector/inspector.md
|
||||
user_guides/brep_wp/brep_wp.md
|
||||
user_guides/vis/vis.md
|
||||
|
||||
dev_guides/dev_guides.md
|
||||
dev_guides/documentation/documentation.md
|
||||
dev_guides/contribution/coding_rules.md
|
||||
dev_guides/contribution_workflow/contribution_workflow.md
|
||||
dev_guides/git_guide/git_guide.md
|
||||
dev_guides/tests/tests.md
|
||||
contribution/contribution.md
|
||||
contribution/documentation/documentation.md
|
||||
contribution/coding_rules.md
|
||||
contribution/contribution_workflow/contribution_workflow.md
|
||||
contribution/git_guide/git_guide.md
|
||||
contribution/tests/tests.md
|
||||
debug/debug.md
|
||||
upgrade/upgrade.md
|
||||
dev_guides/visualization/pbr_math.md
|
||||
|
@ -20,11 +20,12 @@ user_guides/visualization/visualization.md
|
||||
user_guides/xde/xde.md
|
||||
user_guides/vis/vis.md
|
||||
|
||||
dev_guides/contribution_workflow/contribution_workflow.md
|
||||
dev_guides/documentation/documentation.md
|
||||
dev_guides/contribution/coding_rules.md
|
||||
dev_guides/git_guide/git_guide.md
|
||||
dev_guides/tests/tests.md
|
||||
contribution/contribution_workflow/contribution_workflow.md
|
||||
contribution/documentation/documentation.md
|
||||
contribution/coding_rules.md
|
||||
contribution/git_guide/git_guide.md
|
||||
contribution/tests/tests.md
|
||||
|
||||
upgrade/upgrade.md
|
||||
dev_guides/visualization/pbr_math.md
|
||||
|
||||
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 73 KiB |
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
@ -30,7 +30,7 @@ You can use *custom.bat* file to add necessary paths to the *PATH* variable.
|
||||
Note that in the process of PDF generation MiKTeX may need some packages not installed by default.
|
||||
We recommend setting option "Install missing packages on-the-fly" to "Ask me first" (default) during MiKTeX installation:
|
||||
|
||||
@figure{/dev_guides/documentation/images/documentation_miktex.png,"",320}
|
||||
@figure{/contribution/documentation/images/documentation_miktex.png,"",320}
|
||||
|
||||
On the first run of **pdflatex** it will open a dialog window prompting for installation of missing packages.
|
||||
Follow the instructions to proceed (define proxy settings if needed, select a mirror site to download from, etc.).
|
||||
@ -102,7 +102,7 @@ The MarkDown files have a <i>*.md</i> extension and are based on rules described
|
||||
|
||||
@subsection OCCT_DM_SECTION_3_2 Directory Structure
|
||||
|
||||
@figure{/dev_guides/documentation/images/documentation_folders.png,"",160}
|
||||
@figure{/contribution/documentation/images/documentation_folders.png,"",160}
|
||||
|
||||
Each document has its own folder if there are any images used in it. These images are stored in *images* subfolder.
|
||||
|
||||
@ -112,7 +112,7 @@ If you want to use the same image for several documents, you can place it in *do
|
||||
|
||||
|
||||
@verbatim
|
||||
@figure{/dev_guides/documentation/images/documentation_test_image.svg,"",420}
|
||||
@figure{/contribution/documentation/images/documentation_test_image.svg,"",420}
|
||||
@endverbatim
|
||||
|
||||
|
||||
@ -399,12 +399,12 @@ Captions are included below the image; in PDF output the images with caption are
|
||||
Example:
|
||||
|
||||
@verbatim
|
||||
@figure{/dev_guides/documentation/images/documentation_test_image.svg,"Test SVG image"}
|
||||
@figure{/contribution/documentation/images/documentation_test_image.svg,"Test SVG image"}
|
||||
@endverbatim
|
||||
|
||||
is rendered as:
|
||||
|
||||
@figure{/dev_guides/documentation/images/documentation_test_image.svg,"Test SVG image",320}
|
||||
@figure{/contribution/documentation/images/documentation_test_image.svg,"Test SVG image",320}
|
||||
|
||||
We recommend using **Inkscape** for creation and edition of vector graphics.
|
||||
The graphics created in MS Word Draw and some other vector editors can be copy-pasted to Inkscape and saved as SVG images.
|
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 5.5 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 167 KiB After Width: | Height: | Size: 167 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
@ -273,7 +273,7 @@ The names *begin, end, data, parse.rules, grids.list* and *cases.list* are reser
|
||||
|
||||
General layout of test scripts is shown in Figure 1.
|
||||
|
||||
@figure{/dev_guides/tests/images/tests_image001.png,"Layout of tests folder",400}
|
||||
@figure{/contribution/tests/images/tests_image001.png,"Layout of tests folder",400}
|
||||
|
||||
|
||||
@subsection testmanual_2_2 Test Groups
|