diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cf00065939..220d9e07f6 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -15,10 +15,10 @@ name: Build on: pull_request: paths-ignore: - - 'doc/**' + - 'Documentation/**' push: paths-ignore: - - 'doc/**' + - 'Documentation/**' branches: - master - 'releases/*' diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 924113596c..02799f9683 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -15,7 +15,7 @@ name: Check on: pull_request: paths-ignore: - - 'doc/**' + - 'Documentation/**' jobs: check: diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index c32f707dde..10560aa522 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -10,32 +10,20 @@ # See the License for the specific language governing permissions and # limitations under the License. # -name: Doc - +name: "Build Documentation" on: pull_request: - paths: - - 'docs/**' + push: jobs: docs: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v1 + - uses: ammaraskar/sphinx-action@master with: - path: nuttx - fetch-depth: 1 - - name: Generate Inlined Docs - run: | - echo "Inline Docs" - npm install --no-audit inliner - inliner=`pwd`/node_modules/inliner/cli/index.js - build_output=`pwd`/build - mkdir $build_output - cd nuttx/Documentation - find ./ -type f -name "*.html" -exec script -e -c "$inliner {} > $build_output/{}" \; - ls -l $build_output/ - - uses: actions/upload-artifact@v1 + docs-folder: "Documentation/" + - uses: actions/upload-artifact@v2 with: - name: htmldocs - path: ./build/ + name: sphinx-docs + path: Documentation/_build/html/ diff --git a/.github/workflows/sphinx-docs.yml b/.github/workflows/sphinx-docs.yml deleted file mode 100644 index b324527dee..0000000000 --- a/.github/workflows/sphinx-docs.yml +++ /dev/null @@ -1,56 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -name: "Build Sphinx Docs" -on: - pull_request: - push: - branches: - - master - - docs - - 'releases/*' - tags: - -jobs: - docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - uses: ammaraskar/sphinx-action@master - with: - docs-folder: "doc/" - - uses: actions/upload-artifact@v2 - with: - name: sphinx-docs - path: doc/_build/html/ - - name: Commit documentation changes - if: github.event_name != 'pull_request' - run: | - git clone https://github.com/v01d/incubator-nuttx.git --branch gh-pages --single-branch gh-pages - cd gh-pages - rm -rf ${GITHUB_REF##*/} - mkdir -p ${GITHUB_REF##*/} - cd ${GITHUB_REF##*/} - cp -r ../../doc/_build/html/* . - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - git add . - git commit -m "Update documentation" -a || true - # The above command will fail if no changes were present, so we ignore - # the return code. - - name: Push changes - if: github.event_name != 'pull_request' - uses: ad-m/github-push-action@master - with: - branch: gh-pages - directory: gh-pages - github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/doc/.gitignore b/Documentation/.gitignore similarity index 100% rename from doc/.gitignore rename to Documentation/.gitignore diff --git a/doc/Makefile b/Documentation/Makefile similarity index 100% rename from doc/Makefile rename to Documentation/Makefile diff --git a/doc/Pipfile b/Documentation/Pipfile similarity index 100% rename from doc/Pipfile rename to Documentation/Pipfile diff --git a/doc/Pipfile.lock b/Documentation/Pipfile.lock similarity index 100% rename from doc/Pipfile.lock rename to Documentation/Pipfile.lock diff --git a/doc/_static/NuttX.png b/Documentation/_static/NuttX.png similarity index 100% rename from doc/_static/NuttX.png rename to Documentation/_static/NuttX.png diff --git a/doc/_static/NuttX320.png b/Documentation/_static/NuttX320.png similarity index 100% rename from doc/_static/NuttX320.png rename to Documentation/_static/NuttX320.png diff --git a/doc/_static/custom.css b/Documentation/_static/custom.css similarity index 100% rename from doc/_static/custom.css rename to Documentation/_static/custom.css diff --git a/Documentation/_static/favicon.ico b/Documentation/_static/favicon.ico new file mode 100644 index 0000000000..40668652bc Binary files /dev/null and b/Documentation/_static/favicon.ico differ diff --git a/doc/applications/index.rst b/Documentation/applications/index.rst similarity index 100% rename from doc/applications/index.rst rename to Documentation/applications/index.rst diff --git a/doc/boards/index.rst b/Documentation/boards/index.rst similarity index 100% rename from doc/boards/index.rst rename to Documentation/boards/index.rst diff --git a/doc/components/binfmt.rst b/Documentation/components/binfmt.rst similarity index 100% rename from doc/components/binfmt.rst rename to Documentation/components/binfmt.rst diff --git a/doc/components/drivers/index.rst b/Documentation/components/drivers/index.rst similarity index 100% rename from doc/components/drivers/index.rst rename to Documentation/components/drivers/index.rst diff --git a/doc/components/filesystem.rst b/Documentation/components/filesystem.rst similarity index 100% rename from doc/components/filesystem.rst rename to Documentation/components/filesystem.rst diff --git a/doc/components/index.rst b/Documentation/components/index.rst similarity index 100% rename from doc/components/index.rst rename to Documentation/components/index.rst diff --git a/doc/components/nsh/builtin.rst b/Documentation/components/nsh/builtin.rst similarity index 100% rename from doc/components/nsh/builtin.rst rename to Documentation/components/nsh/builtin.rst diff --git a/doc/components/nsh/commands.rst b/Documentation/components/nsh/commands.rst similarity index 100% rename from doc/components/nsh/commands.rst rename to Documentation/components/nsh/commands.rst diff --git a/doc/components/nsh/config.rst b/Documentation/components/nsh/config.rst similarity index 100% rename from doc/components/nsh/config.rst rename to Documentation/components/nsh/config.rst diff --git a/doc/components/nsh/customizing.rst b/Documentation/components/nsh/customizing.rst similarity index 100% rename from doc/components/nsh/customizing.rst rename to Documentation/components/nsh/customizing.rst diff --git a/doc/components/nsh/index.rst b/Documentation/components/nsh/index.rst similarity index 100% rename from doc/components/nsh/index.rst rename to Documentation/components/nsh/index.rst diff --git a/doc/components/nsh/installation.rst b/Documentation/components/nsh/installation.rst similarity index 100% rename from doc/components/nsh/installation.rst rename to Documentation/components/nsh/installation.rst diff --git a/doc/components/nsh/login.rst b/Documentation/components/nsh/login.rst similarity index 100% rename from doc/components/nsh/login.rst rename to Documentation/components/nsh/login.rst diff --git a/doc/components/nsh/nsh.rst b/Documentation/components/nsh/nsh.rst similarity index 100% rename from doc/components/nsh/nsh.rst rename to Documentation/components/nsh/nsh.rst diff --git a/doc/components/nxflat.rst b/Documentation/components/nxflat.rst similarity index 100% rename from doc/components/nxflat.rst rename to Documentation/components/nxflat.rst diff --git a/doc/components/nxgraphics/NXOrganization.gif b/Documentation/components/nxgraphics/NXOrganization.gif similarity index 100% rename from doc/components/nxgraphics/NXOrganization.gif rename to Documentation/components/nxgraphics/NXOrganization.gif diff --git a/doc/components/nxgraphics/NuttXScreenShot.jpg b/Documentation/components/nxgraphics/NuttXScreenShot.jpg similarity index 100% rename from doc/components/nxgraphics/NuttXScreenShot.jpg rename to Documentation/components/nxgraphics/NuttXScreenShot.jpg diff --git a/doc/components/nxgraphics/appendix.rst b/Documentation/components/nxgraphics/appendix.rst similarity index 100% rename from doc/components/nxgraphics/appendix.rst rename to Documentation/components/nxgraphics/appendix.rst diff --git a/doc/components/nxgraphics/index.rst b/Documentation/components/nxgraphics/index.rst similarity index 100% rename from doc/components/nxgraphics/index.rst rename to Documentation/components/nxgraphics/index.rst diff --git a/doc/components/nxgraphics/nx.rst b/Documentation/components/nxgraphics/nx.rst similarity index 100% rename from doc/components/nxgraphics/nx.rst rename to Documentation/components/nxgraphics/nx.rst diff --git a/doc/components/nxgraphics/nxcursor.rst b/Documentation/components/nxgraphics/nxcursor.rst similarity index 100% rename from doc/components/nxgraphics/nxcursor.rst rename to Documentation/components/nxgraphics/nxcursor.rst diff --git a/doc/components/nxgraphics/nxfonts.rst b/Documentation/components/nxgraphics/nxfonts.rst similarity index 100% rename from doc/components/nxgraphics/nxfonts.rst rename to Documentation/components/nxgraphics/nxfonts.rst diff --git a/doc/components/nxgraphics/nxgl.rst b/Documentation/components/nxgraphics/nxgl.rst similarity index 100% rename from doc/components/nxgraphics/nxgl.rst rename to Documentation/components/nxgraphics/nxgl.rst diff --git a/doc/components/nxgraphics/nxtk.rst b/Documentation/components/nxgraphics/nxtk.rst similarity index 100% rename from doc/components/nxgraphics/nxtk.rst rename to Documentation/components/nxgraphics/nxtk.rst diff --git a/doc/components/nxgraphics/sample.rst b/Documentation/components/nxgraphics/sample.rst similarity index 100% rename from doc/components/nxgraphics/sample.rst rename to Documentation/components/nxgraphics/sample.rst diff --git a/doc/components/nxwidgets.rst b/Documentation/components/nxwidgets.rst similarity index 100% rename from doc/components/nxwidgets.rst rename to Documentation/components/nxwidgets.rst diff --git a/doc/components/paging.rst b/Documentation/components/paging.rst similarity index 100% rename from doc/components/paging.rst rename to Documentation/components/paging.rst diff --git a/doc/components/pm.png b/Documentation/components/pm.png similarity index 100% rename from doc/components/pm.png rename to Documentation/components/pm.png diff --git a/doc/components/power.rst b/Documentation/components/power.rst similarity index 100% rename from doc/components/power.rst rename to Documentation/components/power.rst diff --git a/doc/components/syslog.rst b/Documentation/components/syslog.rst similarity index 100% rename from doc/components/syslog.rst rename to Documentation/components/syslog.rst diff --git a/doc/conf.py b/Documentation/conf.py similarity index 98% rename from doc/conf.py rename to Documentation/conf.py index a2b4d1850c..054f25ae0b 100644 --- a/doc/conf.py +++ b/Documentation/conf.py @@ -73,7 +73,7 @@ html_css_files = [ html_show_license = True -html_logo = '../Documentation/NuttX.png' +html_logo = '_static/NuttX.png' html_favicon = '_static/favicon.ico' today_fmt = '%d %B %y at %H:%M' diff --git a/doc/contributing/coding_style.rst b/Documentation/contributing/coding_style.rst similarity index 100% rename from doc/contributing/coding_style.rst rename to Documentation/contributing/coding_style.rst diff --git a/doc/contributing/documentation.rst b/Documentation/contributing/documentation.rst similarity index 100% rename from doc/contributing/documentation.rst rename to Documentation/contributing/documentation.rst diff --git a/doc/contributing/index.rst b/Documentation/contributing/index.rst similarity index 100% rename from doc/contributing/index.rst rename to Documentation/contributing/index.rst diff --git a/doc/contributing/workflow.rst b/Documentation/contributing/workflow.rst similarity index 100% rename from doc/contributing/workflow.rst rename to Documentation/contributing/workflow.rst diff --git a/doc/glossary.rst b/Documentation/glossary.rst similarity index 100% rename from doc/glossary.rst rename to Documentation/glossary.rst diff --git a/doc/guides/index.rst b/Documentation/guides/index.rst similarity index 100% rename from doc/guides/index.rst rename to Documentation/guides/index.rst diff --git a/doc/guides/nfs.rst b/Documentation/guides/nfs.rst similarity index 100% rename from doc/guides/nfs.rst rename to Documentation/guides/nfs.rst diff --git a/doc/guides/usbtrace.rst b/Documentation/guides/usbtrace.rst similarity index 100% rename from doc/guides/usbtrace.rst rename to Documentation/guides/usbtrace.rst diff --git a/doc/index.rst b/Documentation/index.rst similarity index 100% rename from doc/index.rst rename to Documentation/index.rst diff --git a/doc/introduction/about.rst b/Documentation/introduction/about.rst similarity index 100% rename from doc/introduction/about.rst rename to Documentation/introduction/about.rst diff --git a/doc/introduction/detailed_support.rst b/Documentation/introduction/detailed_support.rst similarity index 100% rename from doc/introduction/detailed_support.rst rename to Documentation/introduction/detailed_support.rst diff --git a/doc/introduction/development_environments.rst b/Documentation/introduction/development_environments.rst similarity index 100% rename from doc/introduction/development_environments.rst rename to Documentation/introduction/development_environments.rst diff --git a/doc/introduction/index.rst b/Documentation/introduction/index.rst similarity index 100% rename from doc/introduction/index.rst rename to Documentation/introduction/index.rst diff --git a/doc/introduction/licensing.rst b/Documentation/introduction/licensing.rst similarity index 100% rename from doc/introduction/licensing.rst rename to Documentation/introduction/licensing.rst diff --git a/doc/introduction/resources.rst b/Documentation/introduction/resources.rst similarity index 100% rename from doc/introduction/resources.rst rename to Documentation/introduction/resources.rst diff --git a/doc/introduction/supported_platforms.rst b/Documentation/introduction/supported_platforms.rst similarity index 100% rename from doc/introduction/supported_platforms.rst rename to Documentation/introduction/supported_platforms.rst diff --git a/doc/introduction/trademarks.rst b/Documentation/introduction/trademarks.rst similarity index 100% rename from doc/introduction/trademarks.rst rename to Documentation/introduction/trademarks.rst diff --git a/doc/make.bat b/Documentation/make.bat similarity index 100% rename from doc/make.bat rename to Documentation/make.bat diff --git a/doc/quickstart/config_build.rst b/Documentation/quickstart/config_build.rst similarity index 100% rename from doc/quickstart/config_build.rst rename to Documentation/quickstart/config_build.rst diff --git a/doc/quickstart/index.rst b/Documentation/quickstart/index.rst similarity index 100% rename from doc/quickstart/index.rst rename to Documentation/quickstart/index.rst diff --git a/doc/quickstart/organization.rst b/Documentation/quickstart/organization.rst similarity index 100% rename from doc/quickstart/organization.rst rename to Documentation/quickstart/organization.rst diff --git a/doc/reference/index.rst b/Documentation/reference/index.rst similarity index 100% rename from doc/reference/index.rst rename to Documentation/reference/index.rst diff --git a/doc/reference/os/addrenv.rst b/Documentation/reference/os/addrenv.rst similarity index 100% rename from doc/reference/os/addrenv.rst rename to Documentation/reference/os/addrenv.rst diff --git a/doc/reference/os/app_vs_os.rst b/Documentation/reference/os/app_vs_os.rst similarity index 100% rename from doc/reference/os/app_vs_os.rst rename to Documentation/reference/os/app_vs_os.rst diff --git a/doc/reference/os/arch.rst b/Documentation/reference/os/arch.rst similarity index 100% rename from doc/reference/os/arch.rst rename to Documentation/reference/os/arch.rst diff --git a/doc/reference/os/board.rst b/Documentation/reference/os/board.rst similarity index 100% rename from doc/reference/os/board.rst rename to Documentation/reference/os/board.rst diff --git a/doc/reference/os/boardctl.rst b/Documentation/reference/os/boardctl.rst similarity index 100% rename from doc/reference/os/boardctl.rst rename to Documentation/reference/os/boardctl.rst diff --git a/doc/reference/os/conventions.rst b/Documentation/reference/os/conventions.rst similarity index 100% rename from doc/reference/os/conventions.rst rename to Documentation/reference/os/conventions.rst diff --git a/doc/reference/os/index.rst b/Documentation/reference/os/index.rst similarity index 100% rename from doc/reference/os/index.rst rename to Documentation/reference/os/index.rst diff --git a/doc/reference/os/iob.rst b/Documentation/reference/os/iob.rst similarity index 100% rename from doc/reference/os/iob.rst rename to Documentation/reference/os/iob.rst diff --git a/doc/reference/os/led.rst b/Documentation/reference/os/led.rst similarity index 100% rename from doc/reference/os/led.rst rename to Documentation/reference/os/led.rst diff --git a/doc/reference/os/nuttx.rst b/Documentation/reference/os/nuttx.rst similarity index 100% rename from doc/reference/os/nuttx.rst rename to Documentation/reference/os/nuttx.rst diff --git a/doc/reference/os/paging.rst b/Documentation/reference/os/paging.rst similarity index 100% rename from doc/reference/os/paging.rst rename to Documentation/reference/os/paging.rst diff --git a/doc/reference/os/shm.rst b/Documentation/reference/os/shm.rst similarity index 100% rename from doc/reference/os/shm.rst rename to Documentation/reference/os/shm.rst diff --git a/doc/reference/os/smp.rst b/Documentation/reference/os/smp.rst similarity index 100% rename from doc/reference/os/smp.rst rename to Documentation/reference/os/smp.rst diff --git a/doc/reference/os/time_clock.rst b/Documentation/reference/os/time_clock.rst similarity index 100% rename from doc/reference/os/time_clock.rst rename to Documentation/reference/os/time_clock.rst diff --git a/doc/reference/os/wqueue.rst b/Documentation/reference/os/wqueue.rst similarity index 100% rename from doc/reference/os/wqueue.rst rename to Documentation/reference/os/wqueue.rst diff --git a/doc/reference/user/01_task_control.rst b/Documentation/reference/user/01_task_control.rst similarity index 100% rename from doc/reference/user/01_task_control.rst rename to Documentation/reference/user/01_task_control.rst diff --git a/doc/reference/user/02_task_scheduling.rst b/Documentation/reference/user/02_task_scheduling.rst similarity index 100% rename from doc/reference/user/02_task_scheduling.rst rename to Documentation/reference/user/02_task_scheduling.rst diff --git a/doc/reference/user/03_task_control.rst b/Documentation/reference/user/03_task_control.rst similarity index 100% rename from doc/reference/user/03_task_control.rst rename to Documentation/reference/user/03_task_control.rst diff --git a/doc/reference/user/04_message_queue.rst b/Documentation/reference/user/04_message_queue.rst similarity index 100% rename from doc/reference/user/04_message_queue.rst rename to Documentation/reference/user/04_message_queue.rst diff --git a/doc/reference/user/05_counting_semaphore.rst b/Documentation/reference/user/05_counting_semaphore.rst similarity index 100% rename from doc/reference/user/05_counting_semaphore.rst rename to Documentation/reference/user/05_counting_semaphore.rst diff --git a/doc/reference/user/06_clocks_timers.rst b/Documentation/reference/user/06_clocks_timers.rst similarity index 100% rename from doc/reference/user/06_clocks_timers.rst rename to Documentation/reference/user/06_clocks_timers.rst diff --git a/doc/reference/user/07_signals.rst b/Documentation/reference/user/07_signals.rst similarity index 100% rename from doc/reference/user/07_signals.rst rename to Documentation/reference/user/07_signals.rst diff --git a/doc/reference/user/08_pthread.rst b/Documentation/reference/user/08_pthread.rst similarity index 100% rename from doc/reference/user/08_pthread.rst rename to Documentation/reference/user/08_pthread.rst diff --git a/doc/reference/user/09_env_vars.rst b/Documentation/reference/user/09_env_vars.rst similarity index 100% rename from doc/reference/user/09_env_vars.rst rename to Documentation/reference/user/09_env_vars.rst diff --git a/doc/reference/user/10_filesystem.rst b/Documentation/reference/user/10_filesystem.rst similarity index 100% rename from doc/reference/user/10_filesystem.rst rename to Documentation/reference/user/10_filesystem.rst diff --git a/doc/reference/user/11_network.rst b/Documentation/reference/user/11_network.rst similarity index 100% rename from doc/reference/user/11_network.rst rename to Documentation/reference/user/11_network.rst diff --git a/doc/reference/user/12_shared_memory.rst b/Documentation/reference/user/12_shared_memory.rst similarity index 100% rename from doc/reference/user/12_shared_memory.rst rename to Documentation/reference/user/12_shared_memory.rst diff --git a/doc/reference/user/index.rst b/Documentation/reference/user/index.rst similarity index 100% rename from doc/reference/user/index.rst rename to Documentation/reference/user/index.rst diff --git a/doc/reference/user/structures.rst b/Documentation/reference/user/structures.rst similarity index 100% rename from doc/reference/user/structures.rst rename to Documentation/reference/user/structures.rst diff --git a/doc/releases/index.rst b/Documentation/releases/index.rst similarity index 100% rename from doc/releases/index.rst rename to Documentation/releases/index.rst diff --git a/doc/requirements.txt b/Documentation/requirements.txt similarity index 100% rename from doc/requirements.txt rename to Documentation/requirements.txt diff --git a/doc/substitutions.rst b/Documentation/substitutions.rst similarity index 100% rename from doc/substitutions.rst rename to Documentation/substitutions.rst diff --git a/doc/_static/favicon.ico b/doc/_static/favicon.ico deleted file mode 100644 index 2563e58430..0000000000 Binary files a/doc/_static/favicon.ico and /dev/null differ