diff --git a/EDITING.md b/EDITING.md index a04a1f5..bc21702 100644 --- a/EDITING.md +++ b/EDITING.md @@ -1,13 +1,5 @@ # How to edit or modify vaaman-doc -Taking in consideration that there exists a maintainer of each major section -of this documentation repository. - -For example a person dedicated for `linux kernel` should not commit changes for the section that is not `linux kernel`. -If the changes are important then instead create a **patch** for the changes and send that patch over to the designated maintainer to pick and merge on his/her branch. - -This will allow this repository to be conflicts free and thus easier to maintain. - ## Cloning the repository Clone the fresh copy of this repository. @@ -23,8 +15,6 @@ git fetch origin main git checkout FETCH_HEAD ``` ---- - ## Modifying and updating the source Create or edit `.rst` files in **source/** directory as per your requirements and changes. @@ -48,8 +38,6 @@ python -m pipenv update python -m pipenv shell ./make.bat html ``` ---- - ## View the updated documentation ### View the compiled source on your local computer using @@ -68,7 +56,7 @@ ${BROWSER} _build/html/index.html 2. Enter the `_build/html` folder 3. Open the `index.html` file in any web browser. -**If the changes are satisfied then, commit your local changes.** +**If the changes are satifactory then, commit your local changes.** ```bash git add source/ @@ -78,87 +66,43 @@ git commit **While committing make sure to write a well described commit message and commit title.** Some examples on how to write good commit messages: -- vaaman-doc: Introduce documentation for fgpa write. -- README: Add usage documentation for windows users. -- vaaman-doc: linux: Document different vaaman kernel revisions. + +Good: +``` +vaaman-doc: Introduce documentation for fgpa write. +README: Add usage documentation for windows users. +vaaman-doc: linux: Document different vaaman kernel revisions. +``` + +Bad: +``` +add doc +update readme +``` **To check the list of modified files:** ```bash git status ``` ---- - ## Use spellchecker to find mistakes in your changes Read the [Spellchecker Guide](./SPELLING.md) ---- - ## Pushing the modifications to GitHub -If your branch doesn't exists then the first step will be to create your new dedicated branch. - -To create a new branch use following command. -```bash -git checkout -b -``` -Example: `git checkout -b utsav` - -Confirm the branch using `git branch -a`. - -**If your branch already exists then directly push your changes over to your branch.** - -```bash -git push -u origin -``` -Example: `git push origin utsav` - ---- +1. Create a fork of the doc repository +2. [Add this repository as a + remote](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories) +3. Push changes to your remote ## Creating pull request for your modifications Pull requests are required in order to review the modifications that the developers are doing. Reviewing can include typo/spelling errors, indentation errors, compilation errors, etc. -### Creating pull request using web browser - -#### Go to [vaaman-doc GitHub](https://github.com/vicharak-in/vaaman-doc) - - -#### Click on pull request - -![github-pull-request](./images/github-pull-request.webp) - -#### Select your branch over the base branch (`main`) - -![branch-selection-for-pull-request](./images/branch-selection-for-pull-request.webp) - -#### Create pull request - -![create-pull-request](./images/create-pull-request.webp) - -#### Fill up the details on pull request - -Describe the pull request on this page. You should properly title your pull request and write details about this pull request. - -Select a Reviewer from the right window -> :warning: Select the person who is suitable for reviewing your documentation\ -> Hardware documentation should be reviewed by the hardware head. Similarly software lead should review software related pull request. - -On the development tab in the right window, you must select the `issue id` that your pull request closes or fixes.\ -This step is very important and must be followed to close the `issue` automatically upon merge. - -![fill-up-pull-request-details](./images/open-the-pull-request.webp) - ---- - -### Creating pull request using GitHub CLI (`gh` tool) - -Make sure you have pushed the commits to your branch and also check if your current branch is updated with your latest changes. - -```bash -gh pr create -R https://github.com/vicharak-in/vaaman-doc -``` +Refer to [Creating a pull +request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) +for the steps to follow. -Complete the instructions and pull request should be created on GitHub. \ No newline at end of file +Make sure base branch in the PR is `main` diff --git a/Pipfile.lock b/Pipfile.lock index b3c6806..04d05dd 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -34,11 +34,11 @@ }, "beautifulsoup4": { "hashes": [ - "sha256:74e3d1928edc070d21748185c46e3fb33490f22f52a3addee9aee0f4f7781051", - "sha256:b80878c9f40111313e55da8ba20bdba06d8fa3969fc68304167741bbf9e082ed" + "sha256:7e05ad0b6c26108d9990e2235e8a9b4e2c03ead6f391ceb60347f8ebea6b80ba", + "sha256:c684ddec071aa120819889aa9e8940f85c3f3cdaa08e23b9fa26510387897bd5" ], "markers": "python_full_version >= '3.6.0'", - "version": "==4.12.3" + "version": "==4.13.0b2" }, "breathe": { "hashes": [ @@ -50,11 +50,11 @@ }, "certifi": { "hashes": [ - "sha256:922820b53db7a7257ffbda3f597266d435245903d80737e34f8a45ff3e3230d8", - "sha256:bec941d2aa8195e248a60b31ff9f0558284cf01a52591ceda73ea9afffd69fd9" + "sha256:1275f7a45be9464efc1173084eaa30f866fe2e47d389406136d332ed4967ec56", + "sha256:b650d30f370c2b724812bee08008be0c4163b163ddaec3f2546c1caf65f191db" ], "markers": "python_version >= '3.6'", - "version": "==2024.8.30" + "version": "==2024.12.14" }, "charset-normalizer": { "hashes": [ @@ -218,78 +218,78 @@ }, "markupsafe": { "hashes": [ - "sha256:0778de17cff1acaeccc3ff30cd99a3fd5c50fc58ad3d6c0e0c4c58092b859396", - "sha256:0f84af7e813784feb4d5e4ff7db633aba6c8ca64a833f61d8e4eade234ef0c38", - "sha256:17b2aea42a7280db02ac644db1d634ad47dcc96faf38ab304fe26ba2680d359a", - "sha256:242d6860f1fd9191aef5fae22b51c5c19767f93fb9ead4d21924e0bcb17619d8", - "sha256:244dbe463d5fb6d7ce161301a03a6fe744dac9072328ba9fc82289238582697b", - "sha256:26627785a54a947f6d7336ce5963569b5d75614619e75193bdb4e06e21d447ad", - "sha256:2a4b34a8d14649315c4bc26bbfa352663eb51d146e35eef231dd739d54a5430a", - "sha256:2ae99f31f47d849758a687102afdd05bd3d3ff7dbab0a8f1587981b58a76152a", - "sha256:312387403cd40699ab91d50735ea7a507b788091c416dd007eac54434aee51da", - "sha256:3341c043c37d78cc5ae6e3e305e988532b072329639007fd408a476642a89fd6", - "sha256:33d1c36b90e570ba7785dacd1faaf091203d9942bc036118fab8110a401eb1a8", - "sha256:3e683ee4f5d0fa2dde4db77ed8dd8a876686e3fc417655c2ece9a90576905344", - "sha256:3ffb4a8e7d46ed96ae48805746755fadd0909fea2306f93d5d8233ba23dda12a", - "sha256:40621d60d0e58aa573b68ac5e2d6b20d44392878e0bfc159012a5787c4e35bc8", - "sha256:40f1e10d51c92859765522cbd79c5c8989f40f0419614bcdc5015e7b6bf97fc5", - "sha256:45d42d132cff577c92bfba536aefcfea7e26efb975bd455db4e6602f5c9f45e7", - "sha256:48488d999ed50ba8d38c581d67e496f955821dc183883550a6fbc7f1aefdc170", - "sha256:4935dd7883f1d50e2ffecca0aa33dc1946a94c8f3fdafb8df5c330e48f71b132", - "sha256:4c2d64fdba74ad16138300815cfdc6ab2f4647e23ced81f59e940d7d4a1469d9", - "sha256:4c8817557d0de9349109acb38b9dd570b03cc5014e8aabf1cbddc6e81005becd", - "sha256:4ffaaac913c3f7345579db4f33b0020db693f302ca5137f106060316761beea9", - "sha256:5a4cb365cb49b750bdb60b846b0c0bc49ed62e59a76635095a179d440540c346", - "sha256:62fada2c942702ef8952754abfc1a9f7658a4d5460fabe95ac7ec2cbe0d02abc", - "sha256:67c519635a4f64e495c50e3107d9b4075aec33634272b5db1cde839e07367589", - "sha256:6a54c43d3ec4cf2a39f4387ad044221c66a376e58c0d0e971d47c475ba79c6b5", - "sha256:7044312a928a66a4c2a22644147bc61a199c1709712069a344a3fb5cfcf16915", - "sha256:730d86af59e0e43ce277bb83970530dd223bf7f2a838e086b50affa6ec5f9295", - "sha256:800100d45176652ded796134277ecb13640c1a537cad3b8b53da45aa96330453", - "sha256:80fcbf3add8790caddfab6764bde258b5d09aefbe9169c183f88a7410f0f6dea", - "sha256:82b5dba6eb1bcc29cc305a18a3c5365d2af06ee71b123216416f7e20d2a84e5b", - "sha256:852dc840f6d7c985603e60b5deaae1d89c56cb038b577f6b5b8c808c97580f1d", - "sha256:8ad4ad1429cd4f315f32ef263c1342166695fad76c100c5d979c45d5570ed58b", - "sha256:8ae369e84466aa70f3154ee23c1451fda10a8ee1b63923ce76667e3077f2b0c4", - "sha256:93e8248d650e7e9d49e8251f883eed60ecbc0e8ffd6349e18550925e31bd029b", - "sha256:973a371a55ce9ed333a3a0f8e0bcfae9e0d637711534bcb11e130af2ab9334e7", - "sha256:9ba25a71ebf05b9bb0e2ae99f8bc08a07ee8e98c612175087112656ca0f5c8bf", - "sha256:a10860e00ded1dd0a65b83e717af28845bb7bd16d8ace40fe5531491de76b79f", - "sha256:a4792d3b3a6dfafefdf8e937f14906a51bd27025a36f4b188728a73382231d91", - "sha256:a7420ceda262dbb4b8d839a4ec63d61c261e4e77677ed7c66c99f4e7cb5030dd", - "sha256:ad91738f14eb8da0ff82f2acd0098b6257621410dcbd4df20aaa5b4233d75a50", - "sha256:b6a387d61fe41cdf7ea95b38e9af11cfb1a63499af2759444b99185c4ab33f5b", - "sha256:b954093679d5750495725ea6f88409946d69cfb25ea7b4c846eef5044194f583", - "sha256:bbde71a705f8e9e4c3e9e33db69341d040c827c7afa6789b14c6e16776074f5a", - "sha256:beeebf760a9c1f4c07ef6a53465e8cfa776ea6a2021eda0d0417ec41043fe984", - "sha256:c91b394f7601438ff79a4b93d16be92f216adb57d813a78be4446fe0f6bc2d8c", - "sha256:c97ff7fedf56d86bae92fa0a646ce1a0ec7509a7578e1ed238731ba13aabcd1c", - "sha256:cb53e2a99df28eee3b5f4fea166020d3ef9116fdc5764bc5117486e6d1211b25", - "sha256:cbf445eb5628981a80f54087f9acdbf84f9b7d862756110d172993b9a5ae81aa", - "sha256:d06b24c686a34c86c8c1fba923181eae6b10565e4d80bdd7bc1c8e2f11247aa4", - "sha256:d98e66a24497637dd31ccab090b34392dddb1f2f811c4b4cd80c230205c074a3", - "sha256:db15ce28e1e127a0013dfb8ac243a8e392db8c61eae113337536edb28bdc1f97", - "sha256:db842712984e91707437461930e6011e60b39136c7331e971952bb30465bc1a1", - "sha256:e24bfe89c6ac4c31792793ad9f861b8f6dc4546ac6dc8f1c9083c7c4f2b335cd", - "sha256:e81c52638315ff4ac1b533d427f50bc0afc746deb949210bc85f05d4f15fd772", - "sha256:e9393357f19954248b00bed7c56f29a25c930593a77630c719653d51e7669c2a", - "sha256:ee3941769bd2522fe39222206f6dd97ae83c442a94c90f2b7a25d847d40f4729", - "sha256:f31ae06f1328595d762c9a2bf29dafd8621c7d3adc130cbb46278079758779ca", - "sha256:f94190df587738280d544971500b9cafc9b950d32efcb1fba9ac10d84e6aa4e6", - "sha256:fa7d686ed9883f3d664d39d5a8e74d3c5f63e603c2e3ff0abcba23eac6542635", - "sha256:fb532dd9900381d2e8f48172ddc5a59db4c445a11b9fab40b3b786da40d3b56b", - "sha256:fe32482b37b4b00c7a52a07211b479653b7fe4f22b2e481b9a9b099d8a430f2f" + "sha256:0bff5e0ae4ef2e1ae4fdf2dfd5b76c75e5c2fa4132d05fc1b0dabcd20c7e28c4", + "sha256:0f4ca02bea9a23221c0182836703cbf8930c5e9454bacce27e767509fa286a30", + "sha256:1225beacc926f536dc82e45f8a4d68502949dc67eea90eab715dea3a21c1b5f0", + "sha256:131a3c7689c85f5ad20f9f6fb1b866f402c445b220c19fe4308c0b147ccd2ad9", + "sha256:15ab75ef81add55874e7ab7055e9c397312385bd9ced94920f2802310c930396", + "sha256:1a9d3f5f0901fdec14d8d2f66ef7d035f2157240a433441719ac9a3fba440b13", + "sha256:1c99d261bd2d5f6b59325c92c73df481e05e57f19837bdca8413b9eac4bd8028", + "sha256:1e084f686b92e5b83186b07e8a17fc09e38fff551f3602b249881fec658d3eca", + "sha256:2181e67807fc2fa785d0592dc2d6206c019b9502410671cc905d132a92866557", + "sha256:2cb8438c3cbb25e220c2ab33bb226559e7afb3baec11c4f218ffa7308603c832", + "sha256:3169b1eefae027567d1ce6ee7cae382c57fe26e82775f460f0b2778beaad66c0", + "sha256:3809ede931876f5b2ec92eef964286840ed3540dadf803dd570c3b7e13141a3b", + "sha256:38a9ef736c01fccdd6600705b09dc574584b89bea478200c5fbf112a6b0d5579", + "sha256:3d79d162e7be8f996986c064d1c7c817f6df3a77fe3d6859f6f9e7be4b8c213a", + "sha256:444dcda765c8a838eaae23112db52f1efaf750daddb2d9ca300bcae1039adc5c", + "sha256:48032821bbdf20f5799ff537c7ac3d1fba0ba032cfc06194faffa8cda8b560ff", + "sha256:4aa4e5faecf353ed117801a068ebab7b7e09ffb6e1d5e412dc852e0da018126c", + "sha256:52305740fe773d09cffb16f8ed0427942901f00adedac82ec8b67752f58a1b22", + "sha256:569511d3b58c8791ab4c2e1285575265991e6d8f8700c7be0e88f86cb0672094", + "sha256:57cb5a3cf367aeb1d316576250f65edec5bb3be939e9247ae594b4bcbc317dfb", + "sha256:5b02fb34468b6aaa40dfc198d813a641e3a63b98c2b05a16b9f80b7ec314185e", + "sha256:6381026f158fdb7c72a168278597a5e3a5222e83ea18f543112b2662a9b699c5", + "sha256:6af100e168aa82a50e186c82875a5893c5597a0c1ccdb0d8b40240b1f28b969a", + "sha256:6c89876f41da747c8d3677a2b540fb32ef5715f97b66eeb0c6b66f5e3ef6f59d", + "sha256:6e296a513ca3d94054c2c881cc913116e90fd030ad1c656b3869762b754f5f8a", + "sha256:70a87b411535ccad5ef2f1df5136506a10775d267e197e4cf531ced10537bd6b", + "sha256:7e94c425039cde14257288fd61dcfb01963e658efbc0ff54f5306b06054700f8", + "sha256:846ade7b71e3536c4e56b386c2a47adf5741d2d8b94ec9dc3e92e5e1ee1e2225", + "sha256:88416bd1e65dcea10bc7569faacb2c20ce071dd1f87539ca2ab364bf6231393c", + "sha256:88b49a3b9ff31e19998750c38e030fc7bb937398b1f78cfa599aaef92d693144", + "sha256:8c4e8c3ce11e1f92f6536ff07154f9d49677ebaaafc32db9db4620bc11ed480f", + "sha256:8e06879fc22a25ca47312fbe7c8264eb0b662f6db27cb2d3bbbc74b1df4b9b87", + "sha256:9025b4018f3a1314059769c7bf15441064b2207cb3f065e6ea1e7359cb46db9d", + "sha256:93335ca3812df2f366e80509ae119189886b0f3c2b81325d39efdb84a1e2ae93", + "sha256:9778bd8ab0a994ebf6f84c2b949e65736d5575320a17ae8984a77fab08db94cf", + "sha256:9e2d922824181480953426608b81967de705c3cef4d1af983af849d7bd619158", + "sha256:a123e330ef0853c6e822384873bef7507557d8e4a082961e1defa947aa59ba84", + "sha256:a904af0a6162c73e3edcb969eeeb53a63ceeb5d8cf642fade7d39e7963a22ddb", + "sha256:ad10d3ded218f1039f11a75f8091880239651b52e9bb592ca27de44eed242a48", + "sha256:b424c77b206d63d500bcb69fa55ed8d0e6a3774056bdc4839fc9298a7edca171", + "sha256:b5a6b3ada725cea8a5e634536b1b01c30bcdcd7f9c6fff4151548d5bf6b3a36c", + "sha256:ba8062ed2cf21c07a9e295d5b8a2a5ce678b913b45fdf68c32d95d6c1291e0b6", + "sha256:ba9527cdd4c926ed0760bc301f6728ef34d841f405abf9d4f959c478421e4efd", + "sha256:bbcb445fa71794da8f178f0f6d66789a28d7319071af7a496d4d507ed566270d", + "sha256:bcf3e58998965654fdaff38e58584d8937aa3096ab5354d493c77d1fdd66d7a1", + "sha256:c0ef13eaeee5b615fb07c9a7dadb38eac06a0608b41570d8ade51c56539e509d", + "sha256:cabc348d87e913db6ab4aa100f01b08f481097838bdddf7c7a84b7575b7309ca", + "sha256:cdb82a876c47801bb54a690c5ae105a46b392ac6099881cdfb9f6e95e4014c6a", + "sha256:cfad01eed2c2e0c01fd0ecd2ef42c492f7f93902e39a42fc9ee1692961443a29", + "sha256:d16a81a06776313e817c951135cf7340a3e91e8c1ff2fac444cfd75fffa04afe", + "sha256:d8213e09c917a951de9d09ecee036d5c7d36cb6cb7dbaece4c71a60d79fb9798", + "sha256:e07c3764494e3776c602c1e78e298937c3315ccc9043ead7e685b7f2b8d47b3c", + "sha256:e17c96c14e19278594aa4841ec148115f9c7615a47382ecb6b82bd8fea3ab0c8", + "sha256:e444a31f8db13eb18ada366ab3cf45fd4b31e4db1236a4448f68778c1d1a5a2f", + "sha256:e6a2a455bd412959b57a172ce6328d2dd1f01cb2135efda2e4576e8a23fa3b0f", + "sha256:eaa0a10b7f72326f1372a713e73c3f739b524b3af41feb43e4921cb529f5929a", + "sha256:eb7972a85c54febfb25b5c4b4f3af4dcc731994c7da0d8a0b4a6eb0640e1d178", + "sha256:ee55d3edf80167e48ea11a923c7386f4669df67d7994554387f84e7d8b0a2bf0", + "sha256:f3818cb119498c0678015754eba762e0d61e5b52d34c8b13d770f0719f7b1d79", + "sha256:f8b3d067f2e40fe93e1ccdd6b2e1d16c43140e76f02fb1319a05cf2b79d99430", + "sha256:fcabf5ff6eea076f859677f5f0b6b5c1a51e70a376b0579e0eadef8db48c6b50" ], "markers": "python_version >= '3.9'", - "version": "==3.0.1" + "version": "==3.0.2" }, "mdit-py-plugins": { "hashes": [ - "sha256:b51b3bb70691f57f974e257e367107857a93b36f322a9e6d44ca5bf28ec2def9", - "sha256:d8ab27e9aed6c38aa716819fedfde15ca275715955f8a185a8e1cf90fb1d2c1b" + "sha256:0c673c3f889399a33b95e88d2f0d111b4447bdfea7f237dab2d488f459835636", + "sha256:5f2cd1fdb606ddf152d37ec30e46101a60512bc0e5fa1a7002c36647b09e26b5" ], "markers": "python_version >= '3.8'", - "version": "==0.4.0" + "version": "==0.4.2" }, "mdurl": { "hashes": [ @@ -310,11 +310,11 @@ }, "packaging": { "hashes": [ - "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002", - "sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124" + "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759", + "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f" ], "markers": "python_version >= '3.8'", - "version": "==24.1" + "version": "==24.2" }, "pyenchant": { "hashes": [ @@ -336,60 +336,62 @@ }, "pyyaml": { "hashes": [ - "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5", - "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc", - "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df", - "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741", - "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206", - "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27", - "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595", - "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62", - "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98", - "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696", - "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290", - "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9", - "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d", - "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6", - "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867", - "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47", - "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486", - "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6", - "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3", - "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007", - "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938", - "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0", - "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c", - "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735", - "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d", - "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28", - "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4", - "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba", - "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8", - "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef", - "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5", - "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd", - "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3", - "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0", - "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515", - "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c", - "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c", - "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924", - "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34", - "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43", - "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859", - "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673", - "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54", - "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a", - "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b", - "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab", - "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa", - "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c", - "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585", - "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d", - "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f" + "sha256:01179a4a8559ab5de078078f37e5c1a30d76bb88519906844fd7bdea1b7729ff", + "sha256:0833f8694549e586547b576dcfaba4a6b55b9e96098b36cdc7ebefe667dfed48", + "sha256:0a9a2848a5b7feac301353437eb7d5957887edbf81d56e903999a75a3d743086", + "sha256:0b69e4ce7a131fe56b7e4d770c67429700908fc0752af059838b1cfb41960e4e", + "sha256:0ffe8360bab4910ef1b9e87fb812d8bc0a308b0d0eef8c8f44e0254ab3b07133", + "sha256:11d8f3dd2b9c1207dcaf2ee0bbbfd5991f571186ec9cc78427ba5bd32afae4b5", + "sha256:17e311b6c678207928d649faa7cb0d7b4c26a0ba73d41e99c4fff6b6c3276484", + "sha256:1e2120ef853f59c7419231f3bf4e7021f1b936f6ebd222406c3b60212205d2ee", + "sha256:1f71ea527786de97d1a0cc0eacd1defc0985dcf6b3f17bb77dcfc8c34bec4dc5", + "sha256:23502f431948090f597378482b4812b0caae32c22213aecf3b55325e049a6c68", + "sha256:24471b829b3bf607e04e88d79542a9d48bb037c2267d7927a874e6c205ca7e9a", + "sha256:29717114e51c84ddfba879543fb232a6ed60086602313ca38cce623c1d62cfbf", + "sha256:2e99c6826ffa974fe6e27cdb5ed0021786b03fc98e5ee3c5bfe1fd5015f42b99", + "sha256:39693e1f8320ae4f43943590b49779ffb98acb81f788220ea932a6b6c51004d8", + "sha256:3ad2a3decf9aaba3d29c8f537ac4b243e36bef957511b4766cb0057d32b0be85", + "sha256:3b1fdb9dc17f5a7677423d508ab4f243a726dea51fa5e70992e59a7411c89d19", + "sha256:41e4e3953a79407c794916fa277a82531dd93aad34e29c2a514c2c0c5fe971cc", + "sha256:43fa96a3ca0d6b1812e01ced1044a003533c47f6ee8aca31724f78e93ccc089a", + "sha256:50187695423ffe49e2deacb8cd10510bc361faac997de9efef88badc3bb9e2d1", + "sha256:5ac9328ec4831237bec75defaf839f7d4564be1e6b25ac710bd1a96321cc8317", + "sha256:5d225db5a45f21e78dd9358e58a98702a0302f2659a3c6cd320564b75b86f47c", + "sha256:6395c297d42274772abc367baaa79683958044e5d3835486c16da75d2a694631", + "sha256:688ba32a1cffef67fd2e9398a2efebaea461578b0923624778664cc1c914db5d", + "sha256:68ccc6023a3400877818152ad9a1033e3db8625d899c72eacb5a668902e4d652", + "sha256:70b189594dbe54f75ab3a1acec5f1e3faa7e8cf2f1e08d9b561cb41b845f69d5", + "sha256:797b4f722ffa07cc8d62053e4cff1486fa6dc094105d13fea7b1de7d8bf71c9e", + "sha256:7c36280e6fb8385e520936c3cb3b8042851904eba0e58d277dca80a5cfed590b", + "sha256:7e7401d0de89a9a855c839bc697c079a4af81cf878373abd7dc625847d25cbd8", + "sha256:80bab7bfc629882493af4aa31a4cfa43a4c57c83813253626916b8c7ada83476", + "sha256:82d09873e40955485746739bcb8b4586983670466c23382c19cffecbf1fd8706", + "sha256:8388ee1976c416731879ac16da0aff3f63b286ffdd57cdeb95f3f2e085687563", + "sha256:8824b5a04a04a047e72eea5cec3bc266db09e35de6bdfe34c9436ac5ee27d237", + "sha256:8b9c7197f7cb2738065c481a0461e50ad02f18c78cd75775628afb4d7137fb3b", + "sha256:9056c1ecd25795207ad294bcf39f2db3d845767be0ea6e6a34d856f006006083", + "sha256:936d68689298c36b53b29f23c6dbb74de12b4ac12ca6cfe0e047bedceea56180", + "sha256:9b22676e8097e9e22e36d6b7bda33190d0d400f345f23d4065d48f4ca7ae0425", + "sha256:a4d3091415f010369ae4ed1fc6b79def9416358877534caf6a0fdd2146c87a3e", + "sha256:a8786accb172bd8afb8be14490a16625cbc387036876ab6ba70912730faf8e1f", + "sha256:a9f8c2e67970f13b16084e04f134610fd1d374bf477b17ec1599185cf611d725", + "sha256:bc2fa7c6b47d6bc618dd7fb02ef6fdedb1090ec036abab80d4681424b84c1183", + "sha256:c70c95198c015b85feafc136515252a261a84561b7b1d51e3384e0655ddf25ab", + "sha256:cc1c1159b3d456576af7a3e4d1ba7e6924cb39de8f67111c735f6fc832082774", + "sha256:ce826d6ef20b1bc864f0a68340c8b3287705cae2f8b4b1d932177dcc76721725", + "sha256:d584d9ec91ad65861cc08d42e834324ef890a082e591037abe114850ff7bbc3e", + "sha256:d7fded462629cfa4b685c5416b949ebad6cec74af5e2d42905d41e257e0869f5", + "sha256:d84a1718ee396f54f3a086ea0a66d8e552b2ab2017ef8b420e92edbc841c352d", + "sha256:d8e03406cac8513435335dbab54c0d385e4a49e4945d2909a581c83647ca0290", + "sha256:e10ce637b18caea04431ce14fabcf5c64a1c61ec9c56b071a4b7ca131ca52d44", + "sha256:ec031d5d2feb36d1d1a24380e4db6d43695f3748343d99434e6f5f9156aaa2ed", + "sha256:ef6107725bd54b262d6dedcc2af448a266975032bc85ef0172c5f059da6325b4", + "sha256:efdca5630322a10774e8e98e1af481aad470dd62c3170801852d752aa7a783ba", + "sha256:f753120cb8181e736c57ef7636e83f31b9c0d1722c516f7e86cf15b7aa57ff12", + "sha256:ff3824dc5261f50c9b0dfb3be22b4567a6f938ccce4587b38952d85fd9e9afe4" ], - "markers": "python_version >= '3.6'", - "version": "==6.0.1" + "markers": "python_version >= '3.8'", + "version": "==6.0.2" }, "requests": { "hashes": [ @@ -401,11 +403,11 @@ }, "setuptools": { "hashes": [ - "sha256:385eb4edd9c9d5c17540511303e39a147ce2fc04bc55289c322b9e5904fe2c05", - "sha256:be1af57fc409f93647f2e8e4573a142ed38724b8cdd389706a867bb4efcf1e78" + "sha256:8199222558df7c86216af4f84c30e9b34a61d8ba19366cc914424cdbd28252f6", + "sha256:ce74b49e8f7110f9bf04883b730f4765b774ef3ef28f722cce7c273d253aaf7d" ], - "markers": "python_version >= '3.8'", - "version": "==69.0.3" + "markers": "python_version >= '3.9'", + "version": "==75.6.0" }, "snowballstemmer": { "hashes": [ @@ -416,11 +418,11 @@ }, "soupsieve": { "hashes": [ - "sha256:5663d5a7b3bfaeee0bc4372e7fc48f9cff4940b3eec54a6451cc5299f1097690", - "sha256:eaa337ff55a1579b6549dc679565eac1e3d000563bcb1c8ab0d0fefbc0c2cdc7" + "sha256:e2e68417777af359ec65daac1057404a3c8a5455bb8abc36f1a9866ab1a51abb", + "sha256:e72c4ff06e4fb6e4b5a9f0f55fe6e81514581fca1515028625d0f299c602ccc9" ], "markers": "python_version >= '3.8'", - "version": "==2.5" + "version": "==2.6" }, "sphinx": { "hashes": [ @@ -532,6 +534,14 @@ "markers": "python_version >= '3.7'", "version": "==8.0.0" }, + "typing-extensions": { + "hashes": [ + "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d", + "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8" + ], + "markers": "python_version >= '3.8'", + "version": "==4.12.2" + }, "uc-micro-py": { "hashes": [ "sha256:d321b92cff673ec58027c04015fcaa8bb1e005478643ff4a500882eaab88c48a", @@ -550,11 +560,11 @@ }, "wheel": { "hashes": [ - "sha256:177f9c9b0d45c47873b619f5b650346d632cdc35fb5e4d25058e09c9e581433d", - "sha256:c45be39f7882c9d34243236f2d63cbd58039e360f85d0913425fbd7ceea617a8" + "sha256:661e1abd9198507b1409a20c02106d9670b2576e916d58f520316666abca6729", + "sha256:708e7481cc80179af0e556bbf0cc00b8444c7321e2700b8d8580231d13017248" ], - "markers": "python_version >= '3.7'", - "version": "==0.42.0" + "markers": "python_version >= '3.8'", + "version": "==0.45.1" } }, "develop": {} diff --git a/images/branch-selection-for-pull-request.webp b/images/branch-selection-for-pull-request.webp deleted file mode 100644 index 0d21c2d..0000000 Binary files a/images/branch-selection-for-pull-request.webp and /dev/null differ diff --git a/images/create-pull-request.webp b/images/create-pull-request.webp deleted file mode 100644 index 6c75f2a..0000000 Binary files a/images/create-pull-request.webp and /dev/null differ diff --git a/images/github-pull-request.webp b/images/github-pull-request.webp deleted file mode 100644 index 38de53c..0000000 Binary files a/images/github-pull-request.webp and /dev/null differ diff --git a/images/open-the-pull-request.webp b/images/open-the-pull-request.webp deleted file mode 100644 index de5ec09..0000000 Binary files a/images/open-the-pull-request.webp and /dev/null differ diff --git a/source/FPGA_PROJECT.rst b/source/FPGA_PROJECT.rst deleted file mode 100644 index b75e621..0000000 --- a/source/FPGA_PROJECT.rst +++ /dev/null @@ -1,35 +0,0 @@ -########################## -FPGA PROJECT DETAILS -########################## - -1. LED Blinking -2. pass the data using UART - -========================================== -STEPS FOR TESTING AND CLONNING THE PROJECT -========================================== - -1. git clone for clonning the project. - - ``git clone https://github.com/vicharak-in/LED_BLINKING_DEMO.git`` for clonning the LED Blinking whole project. - - ``git clone https://github.com/vicharak-in/UART_RX_TX_DEMO.git`` for clonning the UART demo project. - -2. open the .xml file of the project and follow the steps of interface design to set the desire PLL clock. - -Note: There is no need to set the GPIO pins in both the projects as there already exist .peri.xml file in the repository which contain the input and output pins of the project. - -3. make the proper wire connection on the Vaaman, For that follow `Download Pinouts <_static/files/Vaaman0.3_Pinout_Guide_Rev0.3.pdf>`_ - - in the led blinking , GPIOR_188 for clock, 4 user led used for checking output that is GPIOT_RXN27, GPIOT_RXP27, GPIOT_RXP24, GPIOT_RXN24. - - .. image:: _static/images/LED_BLINK.webp - - in UART test , GPIOR_188 to set the clock 100MHz, connect the UART RX to Tx on the Vaaman board that is GPIOL_62 as well as the UART Tx connect with the Rx on the Vaaman board that is the GPIOL_66. - - .. image:: _static/images/UART_CONNECTION.webp - -4. Synthesize the design, follow the Efinity programmer steps for loading the bitstream, and run the project on Vaaman board. - -5. After programming the Vaaman board with the bitstream, the LED BLINK project's output is immediately displayed output through blinking the board's USER LEDs. For UART output, launch GTKTERM which is the serial communication tool, to view the data being transmitted and reflected in the serial terminal. - diff --git a/source/conf.py b/source/conf.py index 2aab552..514221b 100644 --- a/source/conf.py +++ b/source/conf.py @@ -38,7 +38,7 @@ spelling_show_suggestions = True spelling_show_whole_line = True spelling_word_list_filename = "spelling_wordlist.txt" -spelling_exclude_patterns = ["drm_fpga_api/**", "drm_fpga_write/**", "_build/**"] +spelling_exclude_patterns = ["_build/**"] # Enable colon fence for code blocks myst_enable_extensions = [ @@ -77,7 +77,7 @@ # HTML settings html_theme = "sphinxawesome_theme" -html_static_path = ["_static"] +html_static_path = ["_static", "_static/images"] html_title = "Vicharak" # CSS files to include html_css_files = [ @@ -102,17 +102,13 @@ "**": ["sidebar_main_nav_links.html", "sidebar_toc.html"] } -favicons = [ - "images/android-chrome-192x192.png", - "images/android-chrome-512x512.png", - "images/apple-touch-icon.png", - "images/favicon-16x16.png", - "images/favicon-32x32.png", - "images/favicon.ico", - "images/mstile-150x150.png", - "images/safari-pinned-tab.svg", -] - -# Breathe extension settings -breathe_projects = {"drm_fpga_write": os.getcwd() + "/../xml/"} -breathe_default_project = "drm_fpga_write" +#favicons = [ +# "images/android-chrome-192x192.png", +# "images/android-chrome-512x512.png", +# "images/apple-touch-icon.png", +# "images/favicon-16x16.png", +# "images/favicon-32x32.png", +# "images/favicon.ico", +# "images/mstile-150x150.png", +# "images/safari-pinned-tab.svg", +#] diff --git a/source/contributing.rst b/source/contributing.rst deleted file mode 100644 index 9f42b4a..0000000 --- a/source/contributing.rst +++ /dev/null @@ -1,7 +0,0 @@ -:orphan: - -.. _contributing: - -############## - Contribution -############## diff --git a/source/drm_fpga_api/file/README_8md.rst b/source/drm_fpga_api/file/README_8md.rst deleted file mode 100644 index 5cf0023..0000000 --- a/source/drm_fpga_api/file/README_8md.rst +++ /dev/null @@ -1,4 +0,0 @@ -File README.md -============== - -.. doxygenfile:: README.md diff --git a/source/drm_fpga_api/file/a_8c.rst b/source/drm_fpga_api/file/a_8c.rst deleted file mode 100644 index 7759039..0000000 --- a/source/drm_fpga_api/file/a_8c.rst +++ /dev/null @@ -1,4 +0,0 @@ -File a.c -======== - -.. doxygenfile:: a.c diff --git a/source/drm_fpga_api/file/b_8cpp.rst b/source/drm_fpga_api/file/b_8cpp.rst deleted file mode 100644 index df3e2bd..0000000 --- a/source/drm_fpga_api/file/b_8cpp.rst +++ /dev/null @@ -1,4 +0,0 @@ -File b.cpp -========== - -.. doxygenfile:: b.cpp diff --git a/source/drm_fpga_api/file/custom_8c.rst b/source/drm_fpga_api/file/custom_8c.rst deleted file mode 100644 index e1b573a..0000000 --- a/source/drm_fpga_api/file/custom_8c.rst +++ /dev/null @@ -1,4 +0,0 @@ -File custom.c -============= - -.. doxygenfile:: custom.c diff --git a/source/drm_fpga_api/file/custom_8h.rst b/source/drm_fpga_api/file/custom_8h.rst deleted file mode 100644 index b9f2435..0000000 --- a/source/drm_fpga_api/file/custom_8h.rst +++ /dev/null @@ -1,4 +0,0 @@ -File custom.h -============= - -.. doxygenfile:: custom.h diff --git a/source/drm_fpga_api/file/modeset_8c.rst b/source/drm_fpga_api/file/modeset_8c.rst deleted file mode 100644 index 9ed71e1..0000000 --- a/source/drm_fpga_api/file/modeset_8c.rst +++ /dev/null @@ -1,4 +0,0 @@ -File modeset.c -============== - -.. doxygenfile:: modeset.c diff --git a/source/drm_fpga_api/file/read_8c.rst b/source/drm_fpga_api/file/read_8c.rst deleted file mode 100644 index 7174fe1..0000000 --- a/source/drm_fpga_api/file/read_8c.rst +++ /dev/null @@ -1,4 +0,0 @@ -File read.c -=========== - -.. doxygenfile:: read.c diff --git a/source/drm_fpga_api/file/read_8h.rst b/source/drm_fpga_api/file/read_8h.rst deleted file mode 100644 index 91cfd24..0000000 --- a/source/drm_fpga_api/file/read_8h.rst +++ /dev/null @@ -1,4 +0,0 @@ -File read.h -=========== - -.. doxygenfile:: read.h diff --git a/source/drm_fpga_api/file/test_8c.rst b/source/drm_fpga_api/file/test_8c.rst deleted file mode 100644 index 2bc2dfc..0000000 --- a/source/drm_fpga_api/file/test_8c.rst +++ /dev/null @@ -1,4 +0,0 @@ -File test.c -=========== - -.. doxygenfile:: test.c diff --git a/source/drm_fpga_api/file/try_8c.rst b/source/drm_fpga_api/file/try_8c.rst deleted file mode 100644 index 9ddbae6..0000000 --- a/source/drm_fpga_api/file/try_8c.rst +++ /dev/null @@ -1,4 +0,0 @@ -File try.c -========== - -.. doxygenfile:: try.c diff --git a/source/drm_fpga_api/file/write_8c.rst b/source/drm_fpga_api/file/write_8c.rst deleted file mode 100644 index bfa187d..0000000 --- a/source/drm_fpga_api/file/write_8c.rst +++ /dev/null @@ -1,4 +0,0 @@ -File write.c -============ - -.. doxygenfile:: write.c diff --git a/source/drm_fpga_api/file/write_8h.rst b/source/drm_fpga_api/file/write_8h.rst deleted file mode 100644 index db46a6a..0000000 --- a/source/drm_fpga_api/file/write_8h.rst +++ /dev/null @@ -1,4 +0,0 @@ -File write.h -============ - -.. doxygenfile:: write.h diff --git a/source/drm_fpga_api/filelist.rst b/source/drm_fpga_api/filelist.rst deleted file mode 100644 index 78a5f53..0000000 --- a/source/drm_fpga_api/filelist.rst +++ /dev/null @@ -1,7 +0,0 @@ -File list -========= - -.. toctree:: - :glob: - - file/* diff --git a/source/drm_fpga_api/struct/structfpga__frame.rst b/source/drm_fpga_api/struct/structfpga__frame.rst deleted file mode 100644 index 4eeb10b..0000000 --- a/source/drm_fpga_api/struct/structfpga__frame.rst +++ /dev/null @@ -1,4 +0,0 @@ -Struct fpga_frame -================= - -.. doxygenstruct:: fpga_frame diff --git a/source/drm_fpga_api/struct/structmodeset__dev.rst b/source/drm_fpga_api/struct/structmodeset__dev.rst deleted file mode 100644 index 2105df5..0000000 --- a/source/drm_fpga_api/struct/structmodeset__dev.rst +++ /dev/null @@ -1,4 +0,0 @@ -Struct modeset_dev -================== - -.. doxygenstruct:: modeset_dev diff --git a/source/drm_fpga_api/structlist.rst b/source/drm_fpga_api/structlist.rst deleted file mode 100644 index fc53f2f..0000000 --- a/source/drm_fpga_api/structlist.rst +++ /dev/null @@ -1,7 +0,0 @@ -Struct list -=========== - -.. toctree:: - :glob: - - struct/* diff --git a/source/drm_fpga_write_api.rst b/source/drm_fpga_write_api.rst deleted file mode 100644 index 9e739d3..0000000 --- a/source/drm_fpga_write_api.rst +++ /dev/null @@ -1,9 +0,0 @@ -:orphan: - -.. _drm_fpga_write_api: - -.. toctree:: - :glob: - - drm_fpga_api/structlist.rst - drm_fpga_api/filelist.rst diff --git a/source/index.rst b/source/index.rst index 10e06c1..c212db2 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,7 +9,7 @@ .. rst-class:: lead #################################### - Welcome to Vicharak's documentation! +Welcome to Vicharak's documentation! #################################### Vicharak brings to you the powerful rk3399 based Vaaman and the highly advanced rk3588 based Axon single-board computers (SBCs). @@ -44,6 +44,7 @@ applications including IoT, AI and multimedia processing. :glob: :caption: Contents :titlesonly: + :maxdepth: 1 Vaaman SBC Axon SBC @@ -68,5 +69,3 @@ applications including IoT, AI and multimedia processing. We welcome feedback and bug reports through our `Support discussion `_. - - Visit :doc:`faq` for more information. diff --git a/source/vicharak_sbcs/axon/axon-accessories/accessory-raspi-cam.rst b/source/vicharak_sbcs/axon/axon-accessories/accessory-raspi-cam.rst index 5233a61..29cea61 100644 --- a/source/vicharak_sbcs/axon/axon-accessories/accessory-raspi-cam.rst +++ b/source/vicharak_sbcs/axon/axon-accessories/accessory-raspi-cam.rst @@ -25,7 +25,6 @@ Pi Camera documentation Buy the `Raspberry Pi Camera Module v2 `_. -| ####################### Axon Camera Guide ####################### @@ -88,7 +87,7 @@ Enable Overlays In Axon Make sure that whenever you are going to connect Camera, Device should be power off. -How to attach camare to Axon +How to Attach Camera to Axon ---------------------------- 1. First, Connect Vicharak Flex Cable To Vicharak CAM PCB Connector. @@ -126,7 +125,7 @@ How to attach camare to Axon For Single Camera --------------- +----------------- Run Camera Using V4l2 Utility ------------------------------ @@ -186,9 +185,7 @@ for Debian-based systems (like Ubuntu): Setup ------ - .. tab-set:: - - .. tab-item:: + 1. Open a terminal window(``Ctrl+Alt+T``). 2. To create a (``.py``) file in vim editor, Run command ``vim .py`` in terminal. @@ -240,10 +237,8 @@ Setup If you have multiple versions of Python installed, ensure you use ``python3`` to run the program for Python 3.x. -| **Troubleshooting** - - If you encounter any errors related to missing modules or libraries, ensure that Python and OpenCV are properly installed on your system. - If the camera frame does not open or the program does not behave as expected, check for any errors in the terminal output and review your program for potential issues. diff --git a/source/vicharak_sbcs/axon/axon-downloads.rst b/source/vicharak_sbcs/axon/axon-downloads.rst index 2ac427b..6a85181 100644 --- a/source/vicharak_sbcs/axon/axon-downloads.rst +++ b/source/vicharak_sbcs/axon/axon-downloads.rst @@ -74,6 +74,7 @@ SoC Documents Axon Pin-outs Guide --------------------- .. TODO: Add link for Axon 3D File + `Download Pinouts `_ Mechanical Information diff --git a/source/vicharak_sbcs/axon/axon-faq.rst b/source/vicharak_sbcs/axon/axon-faq.rst index 37a52ef..a37492d 100644 --- a/source/vicharak_sbcs/axon/axon-faq.rst +++ b/source/vicharak_sbcs/axon/axon-faq.rst @@ -4,6 +4,7 @@ Frequently Asked Questions ========================== .. TODO: Add axon-linux-uart-serial-console (Axon Linux Usage Guide) + How to take logs ---------------- @@ -46,7 +47,7 @@ How to take logs If the device is not booting up, then take the logs from the serial port tool and attach it to the issue. Does Axon have an FPGA? -------------------- +----------------------- No How to report a bug diff --git a/source/vicharak_sbcs/axon/axon-getting-started.rst b/source/vicharak_sbcs/axon/axon-getting-started.rst index f0e63bb..82211c9 100644 --- a/source/vicharak_sbcs/axon/axon-getting-started.rst +++ b/source/vicharak_sbcs/axon/axon-getting-started.rst @@ -9,6 +9,7 @@ the initial setup process and provide you with the necessary information to get started with Axon. .. TODO: Modify this for Axon + What's in the box? ================== @@ -50,12 +51,12 @@ What else do you need? | You can purchase them from the :ref:`axon-accessories` page. Axon OS Images -============ +============== :ref:`axon-downloads` Axon Button Guide -======================== +================= .. image:: ../../_static/images/rk3588-axon/axon-button-guide.webp :width: 50% @@ -79,6 +80,7 @@ Axon Button Guide .. note:: | *To get Axon in MaskRom Mode*, Need to press reset button 2-3 times with holding boot button. + `Watch Video tutorial to get Board in MaskRom Mode `_ Getting Started with eMMC @@ -157,6 +159,7 @@ Available Boot Modes .. TODO: Add Axon SD card boot doc + Booting from SD card -------------------- To boot from SD card, please follow below document. @@ -164,6 +167,7 @@ To boot from SD card, please follow below document. :doc:`axon-sdcard-boot` .. TODO: Add suppoprt for Axon + How to access your Axon board ? ================================= There are multiple ways to access your Axon. You can connect the Axon @@ -181,8 +185,8 @@ connect the Axon to your computer using the USB-C port. If you want to access the **Axon using SSH**, Skip to the :ref:`SSH ` section. - .. TODO: Add axon start guide + 1. Using Micro HDMI port ------------------------- @@ -278,9 +282,11 @@ Hardware Setup Running the Serial Console Program `````````````````````````````````` + .. include:: ../common/common-serial-console-program.rst .. _axon-ssh: + 3. Using SSH ------------- @@ -333,7 +339,6 @@ Axon Boot modes In general, there is no need to enter `Maskrom` mode. In this mode, the bootrom code waits for the host to transmit the bootloader code through the USB-C port, load and run it. - | :ref:`Learn more about maskrom mode `. .. seealso:: diff --git a/source/vicharak_sbcs/axon/axon-home.rst b/source/vicharak_sbcs/axon/axon-home.rst index 9dd5e68..9afa223 100644 --- a/source/vicharak_sbcs/axon/axon-home.rst +++ b/source/vicharak_sbcs/axon/axon-home.rst @@ -24,19 +24,16 @@ The **Axon Board Computer** (SBC) is powered by rockchip's **RK3588** :titlesonly: :caption: Downloads - vicharak_sbcs/axon/axon-downloads + Axon Downloads .. toctree:: :glob: :caption: Accessories :titlesonly: - vicharak_sbcs/axon/axon-accessories + Axon Accessories .. note:: We welcome contributions and bug reports through our `GitHub repository `_. - - See the :doc:`contributing` guide and :doc:`faq` for more - information. diff --git a/source/vicharak_sbcs/axon/axon-linux/linux-usage-guide/axon-linux-start-guide.md b/source/vicharak_sbcs/axon/axon-linux/linux-usage-guide/axon-linux-start-guide.md index 915b6cb..6428d1d 100644 --- a/source/vicharak_sbcs/axon/axon-linux/linux-usage-guide/axon-linux-start-guide.md +++ b/source/vicharak_sbcs/axon/axon-linux/linux-usage-guide/axon-linux-start-guide.md @@ -1,4 +1,4 @@ -(linux-start-guide)= +(axon-linux-start-guide)= # Vicharak Linux Start Guide diff --git a/source/vicharak_sbcs/vaaman/vaaman-accessories/accessory-raspi-cam.rst b/source/vicharak_sbcs/vaaman/vaaman-accessories/accessory-raspi-cam.rst index ef485e6..0ded3e1 100755 --- a/source/vicharak_sbcs/vaaman/vaaman-accessories/accessory-raspi-cam.rst +++ b/source/vicharak_sbcs/vaaman/vaaman-accessories/accessory-raspi-cam.rst @@ -1,7 +1,7 @@ :orphan: ############################ - Raspberry Pi Camera Module +Raspberry Pi Camera Module ############################ .. image:: ../../../_static/images/rk3399-vaaman/accessory-rpi-camera-module.webp @@ -25,7 +25,6 @@ Pi Camera documentation Buy the `Raspberry Pi Camera Module v2 `_. -| ####################### Vaaman Camera Guide ####################### @@ -53,7 +52,7 @@ Pre-Requisites - FPC50 15 Pin 1mm Pitch Cable Enable Overlays In Vaaman / Axon ------------------------- +-------------------------------- **Steps to follow for Configuration** @@ -85,6 +84,7 @@ Enable Overlays In Vaaman / Axon Setup ------ + .. tab-set:: .. tab-item:: Cheese Application @@ -132,12 +132,10 @@ Setup .. tab-item:: Python Source - | **Introduction** This documentation provides instructions on how to run the Python to open the camera frame and capture an image using OpenCV. - | **Pre-Requisites** @@ -162,7 +160,6 @@ Setup sudo apt update sudo apt-get install gedit - | **Setup** @@ -188,7 +185,6 @@ Setup pip install opencv-python - | **Execution of Program** 1. Open a terminal window(``Ctrl+Alt+T``). @@ -226,7 +222,6 @@ Setup If you have multiple versions of Python installed, ensure you use ``python3`` to run the program for Python 3.x. - | **Expected Behavior** @@ -247,7 +242,6 @@ Setup 4. Press the key ``Q`` on your keyboard to exit the camera frame. - | **Troubleshooting** diff --git a/source/vicharak_sbcs/vaaman/vaaman-downloads.rst b/source/vicharak_sbcs/vaaman/vaaman-downloads.rst index 5d36de1..5269959 100644 --- a/source/vicharak_sbcs/vaaman/vaaman-downloads.rst +++ b/source/vicharak_sbcs/vaaman/vaaman-downloads.rst @@ -32,8 +32,6 @@ OS Images xz -d .xz -| - .. seealso:: How to flash the image to the board using @@ -148,14 +146,3 @@ Step File 7z x .7z -| - -.. seealso:: - - :ref:`Contributing to Vaaman ` - - :ref:`Frequently Asked Questions ` - - :ref:`Vaaman FPGA Programming Guide ` - - :doc:`Vaaman Linux Guide ` diff --git a/source/vicharak_sbcs/vaaman/vaaman-fpga/install.rst b/source/vicharak_sbcs/vaaman/vaaman-fpga/install.rst index 7731eab..899f4cc 100644 --- a/source/vicharak_sbcs/vaaman/vaaman-fpga/install.rst +++ b/source/vicharak_sbcs/vaaman/vaaman-fpga/install.rst @@ -27,7 +27,6 @@ Installation tar -xvf downloaded_folder_name.tar.bz2 - | ``cd /bin/`` directory and run the following command to setup your IDE .. code-block:: @@ -48,17 +47,14 @@ Installation sudo apt install libxcb* - | For Installation of drivers , from the /bin directory run: .. code-block:: shell sudo ./install_usb_driver.sh - | After setting up just writing efinity on your terminal will start the efinity software. - | For detailed information: see `software guide `_. @@ -71,7 +67,7 @@ Installation .. code-block:: shell /bin/install_desktop.sh - | + **Efinity Quick Start** For launching the Efinity Graphical User interface (GUI), Double click on the desktop icon. @@ -112,7 +108,6 @@ Installation efx_run.bat --help - | **Installing USB Drivers** Download the Zadig software(version 2.7 or later) from `zadig.akeo.ie `_. @@ -151,7 +146,6 @@ Installation 3. Optionally, add the path to GTKWave's bin folder to your System Variables path if necessary for correct launch. 4. Execute gtkwave.exe found in the bin directory of the installation folder to run the program. - | **GTKWave Installation in Linux** For Linux users, use the following commands: diff --git a/source/vicharak_sbcs/vaaman/vaaman-fpga/vaaman-fpga-programming.rst b/source/vicharak_sbcs/vaaman/vaaman-fpga/vaaman-fpga-programming.rst index b41758a..225d93b 100644 --- a/source/vicharak_sbcs/vaaman/vaaman-fpga/vaaman-fpga-programming.rst +++ b/source/vicharak_sbcs/vaaman/vaaman-fpga/vaaman-fpga-programming.rst @@ -47,8 +47,8 @@ .. image:: /_static/images/rk3399-vaaman/vaaman-efinity-programmer-jtag.webp :width: 50% - Wait for the programming to complete. When the programming is complete, - the FPGA will be configured with the bitstream. + Wait for the programming to complete. When the programming is complete, + the FPGA will be configured with the bitstream. .. tab-item:: Configure fpga from linux command diff --git a/source/vicharak_sbcs/vaaman/vaaman-getting-started.rst b/source/vicharak_sbcs/vaaman/vaaman-getting-started.rst index 87eff6b..829108c 100644 --- a/source/vicharak_sbcs/vaaman/vaaman-getting-started.rst +++ b/source/vicharak_sbcs/vaaman/vaaman-getting-started.rst @@ -41,6 +41,7 @@ What else do you need? .. warning:: | **You must attach the Wi-Fi antenna for proper Wi-Fi functionality and the Bluetooth antenna for proper Bluetooth functionality on Vaaman.** | **Refer to the images given below for correct connector locations.** + Connections: - **Wi-Fi Antenna:** Connect to Wi-Fi antenna connector on reset key side. - **Bluetooth Antenna:** Connect to BLE antenna connector on MIPI-DSI connector side. @@ -146,7 +147,7 @@ For the initial setup process, we recommend connecting the Vaaman to a monitor u Skip to the :ref:`Serial Console ` section. If you want to access the **Vaaman using SSH**, - Skip to the :ref:`SSH ` section. + Skip to the :ref:`SSH ` section. 1. Using Micro HDMI Port ------------------------ @@ -188,7 +189,7 @@ For the initial setup process, we recommend connecting the Vaaman to a monitor u 2. Access the system's console through the connected serial interface. -.. _ssh: +.. _ssh_login: Default Login Credentials ------------------------- @@ -333,7 +334,7 @@ Running the Serial Console Program Vaaman supports **SSH (Secure Shell)**, enabling secure remote access to the system. By establishing an SSH connection, users can remotely connect to Vaaman from another device over a network, such as a computer or smartphone. This method provides a secure command-line interface to administer, configure, and execute commands on Vaaman. Install OpenSSH server -~~~~~~~~~~~~~~~~~~~~~~ +====================== You can install both OpenSSH components on Windows devices using the **Windows Settings**. @@ -352,7 +353,7 @@ To install the OpenSSH components, follow these steps: 7. To start the service, click on **Start**. Verify OpenSSH server -~~~~~~~~~~~~~~~~~~~~ +===================== Once installed, you can connect to the OpenSSH Server from a Windows device with the OpenSSH client installed. @@ -374,7 +375,7 @@ Example: For Linux users, use the following command: ``ip a``. Accessing Vaaman through SSH -```````````````````````````` +============================ To access Vaaman via SSH, you can use either of the following commands: @@ -441,15 +442,3 @@ To access Vaaman via SSH, you can use either of the following commands: In this mode, the bootrom code waits for the host to transmit the bootloader code through the USB-C port, load and run it. | :ref:`Learn more about maskrom mode `. - -.. seealso:: - - :ref:`faq` - - :ref:`vaaman-applications` - - :doc:`vaaman-linux/index` - - :doc:`vaaman-fpga` - - :ref:`downloads` diff --git a/source/vicharak_sbcs/vaaman/vaaman-home.rst b/source/vicharak_sbcs/vaaman/vaaman-home.rst index 219af1b..4cc3179 100644 --- a/source/vicharak_sbcs/vaaman/vaaman-home.rst +++ b/source/vicharak_sbcs/vaaman/vaaman-home.rst @@ -44,5 +44,3 @@ that require both processing power and hardware customization. We welcome contributions and bug reports through our `GitHub repository `_. - See the :doc:`contributing` guide and :doc:`faq` for more - information. diff --git a/source/vicharak_sbcs/vaaman/vaaman-sdk.rst b/source/vicharak_sbcs/vaaman/vaaman-sdk.rst deleted file mode 100644 index 9427e23..0000000 --- a/source/vicharak_sbcs/vaaman/vaaman-sdk.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _vaaman-sdk: - -############ - Vaaman SDK -############ - -Software Development with Vaaman - -********** - API Docs -********** - -- See api doc for :ref:`drm_fpga_write `