diff --git a/.github/workflows/compile_docs.yml b/.github/workflows/compile_docs.yml index 404c02bf7a..0cc3c10c2e 100644 --- a/.github/workflows/compile_docs.yml +++ b/.github/workflows/compile_docs.yml @@ -66,7 +66,7 @@ jobs: - name: Build docs run: docs/build.py html - name: Remove .doctrees - run: rm -rf docs/output/html/.doctrees + run: rm -rf docs/build/html/.doctrees - name: Retrieve version run: | echo "::set-output name=VERSION_NAME::$(scripts/find_version.sh)" @@ -77,7 +77,7 @@ jobs: token: ${{ secrets.LVGL_BOT_TOKEN }} repository-name: lvgl/docs branch: gh-pages # The branch the action should deploy to. - folder: docs/output/html # The folder the action should deploy. + folder: docs/build/html # The folder the action should deploy. target-folder: ${{ steps.version.outputs.VERSION_NAME }} git-config-name: lvgl-bot git-config-email: lvgl-bot@users.noreply.github.com @@ -89,7 +89,7 @@ jobs: token: ${{ secrets.LVGL_BOT_TOKEN }} repository-name: lvgl/docs branch: gh-pages # The branch the action should deploy to. - folder: docs/output/html # The folder the action should deploy. + folder: docs/build/html # The folder the action should deploy. target-folder: master git-config-name: lvgl-bot git-config-email: lvgl-bot@users.noreply.github.com diff --git a/docs/.gitignore b/docs/.gitignore index 30fa502e4d..cc34143f85 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,11 +1,2 @@ -output/ -tmp/ -xml/ -API/ -api_doc -doxygen_html -env -examples.md -examples.rst -LVGL.pdf -_static/built_lv_examples +build/ +intermediate/ diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst deleted file mode 100644 index 8b336f40d8..0000000000 --- a/docs/CONTRIBUTING.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _contributing: - -============ -Contributing -============ - -Introduction -************ - -Join LVGL's community and leave your footprint in the library! - -There are a lot of ways to contribute to LVGL even if you are new to the -library or even new to programming. - -It might be scary to make the first step but you have nothing to be -afraid of. A friendly and helpful community is waiting for you. Get to -know like-minded people and make something great together. - -So let's find which contribution option fits you the best and helps you -join the development of LVGL! - -Ways to Contribute -****************** - -- **Spread the Word**: Share your LVGL experience with friends or on social media to boost its visibility. -- **Star LVGL** Give us a star on `GitHub `__! It helps a lot to make LVGL more appealing for newcomers. -- **Report a Bug**: Open a `GitHub Issue `__ if something is not working. -- **Join Our** `Forum `__ : Meet fellow developers and discuss questions. -- **Tell Us Your Ideas**: If you feel something is missing from LVGL, we would love to hear about it in a `GitHub Issue `__ -- **Develop Features**: Help to design or develop a feature. See below. - -Mid- and large-scale issues are discussed in `Feature Planning `__ issues. - -An issue can be developed when all the questions in the issue template are answered and there are no objection from any core member. - -We are using GitHub labels to show the state and attributes of the issues and Pull requests. -If you are looking for contribution opportunities you can `Filter for these labels `__ : - -- ``Simple``: Good choice to get started with an LVGL contribution -- ``PR needed``: We investigated the issue but it still needs to be implemented -- ``Review needed``: A Pull request is opened and it needs review/testing - - -.. _contributing_pull_requests: - -Pull Requests -************* - -Merging new code into LVGL, documentation, blog, examples, and other -repositories happens via *Pull requests* (PR for short). A PR is a -notification like "Hey, I made some updates to your project. Here are -the changes, you can add them if you want." To do this you need a copy -(called fork) of the original project under your account, make some -changes there, and notify the original repository about your updates. -You can see what it looks like on GitHub for LVGL here: -https://github.com/lvgl/lvgl/pulls. - -To add your changes you can edit files online on GitHub and send a new -Pull request from there (recommended for small changes) or add the -updates in your favorite editor/IDE and use ``git`` to publish the changes -(recommended for more complex updates). - -From GitHub ------------ - -1. Navigate to the file you want to edit. -2. Click the Edit button in the top right-hand corner. -3. Add your changes to the file. -4. Add a commit message at the bottom of the page. -5. Click the *Propose changes* button. - -From Command Line ------------------ - -The instructions describe the main ``lvgl`` repository but it works the -same way for the other repositories. - -1. Fork the `lvgl repository `__. To do this click the - "Fork" button in the top right corner. It will "copy" the ``lvgl`` - repository to your GitHub account (``https://github.com/?tab=repositories``) -2. Clone your forked repository. -3. Add your changes. You can create a *feature branch* from THE ``master`` branch for the updates: ``git checkout -b `` -4. Commit and push your changes to the forked ``lvgl`` repository. -5. Create a PR on GitHub from the page of your ``lvgl`` repository (``https://github.com//lvgl``) by - clicking the *"New pull request"* button. Don't forget to select the branch where you added your changes. -6. Set the base branch where you want to merge your update. In the ``lvgl`` repo both fixes - and new features are directed to the ``master`` branch. -7. Describe what is in the update. Example code is welcome if applicable. -8. If you need to make more changes, just update your forked ``lvgl`` repo with new commits. - They will automatically appear in the PR. - -.. _contributing_commit_message_format: - -Commit Message Format ---------------------- - -The commit messages format is inspired by `Angular Commit -Format `__. - -The following structure should be used: - -.. code-block:: - - (): - - - -