lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-09-09 14:18:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation, Configuration - Correct guides and generation setup (#1404)

Browse Source 
Correct obsolete API references, code examples, terminology, links, and
contribution workflow instructions across the documentation.

Generate Doxygen example paths from OCCT package metadata and fix license
markup. Remove obsolete documentation CMake, layout, and unused PDF
generation files.
This commit is contained in:
Pasukhin Dmitry
2026-07-29 00:36:13 +01:00
committed by GitHub
parent 13526d7a1b
commit fcf1ea22e9
28 changed files with 117 additions and 708 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/CLA_SIGNING.md
+1 -1
View File
@@ -13,7 +13,7 @@ Accepting and signing the Contributor License Agreement is a prerequisite for co
2. Download the Contribution License Agreement pdf file and print it
3. Read the agreement and sign it
4. Scan the signed CLA to a pdf file
5. If not yet done, log on to this website
5. If not yet done, log on to [the OCCT development portal](https://dev.opencascade.org)
6. In the CLA sending form, press the "Browse" button
7. Select your signed CLA file
8. Press "Send"
.github/CONTRIBUTING.md
+2 -2
View File
@@ -11,10 +11,10 @@ In order to contribute code to OCCT you must sign the Contributor License Agreem
### Steps to Submit Your Contribution
1. **Fork the repository** on GitHub: https://github.com/Open-Cascade-SAS/OCCT
2. **Create a feature branch** from an up-to-date `master`. Any descriptive branch name is fine.
2. **Create a feature branch** from an up-to-date `IR`. Any descriptive branch name is fine.
3. **Develop your change** following the [OCCT Coding Rules](https://dev.opencascade.org/doc/overview/html/occt_contribution__coding_rules.html). Format the source with `clang-format` using the `.clang-format` configuration shipped in the repository.
4. **Test locally**. Run the existing DRAW test suite and `OpenCascadeGTest` tests; create a test case for the change when applicable.
5. **Open a Draft Pull Request** against `Open-Cascade-SAS/OCCT:master`. CI/CD pipelines run on every push and report build, style and test results.
5. **Open a Draft Pull Request** against `Open-Cascade-SAS/OCCT:IR`. CI/CD pipelines run on every push and report build, style and test results.
6. **Mark the PR Ready for Review** once CI is green. A maintainer will review the change and request updates as needed.
7. **Address review feedback** by pushing additional commits to the same branch; CI re-runs automatically.
8. After approval the PR is merged (typically squashed) by a maintainer.