rename doc/ -> Documentation/

This commit is contained in:
Matias N 2020-08-14 17:01:22 -03:00 committed by Brennan Ashton
parent 6d89ae8fc7
commit 4276d6254a
98 changed files with 13 additions and 81 deletions

View File

@ -15,10 +15,10 @@ name: Build
on: on:
pull_request: pull_request:
paths-ignore: paths-ignore:
- 'doc/**' - 'Documentation/**'
push: push:
paths-ignore: paths-ignore:
- 'doc/**' - 'Documentation/**'
branches: branches:
- master - master
- 'releases/*' - 'releases/*'

View File

@ -15,7 +15,7 @@ name: Check
on: on:
pull_request: pull_request:
paths-ignore: paths-ignore:
- 'doc/**' - 'Documentation/**'
jobs: jobs:
check: check:

View File

@ -10,32 +10,20 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# #
name: Doc name: "Build Documentation"
on: on:
pull_request: pull_request:
paths: push:
- 'docs/**'
jobs: jobs:
docs: docs:
runs-on: ubuntu-18.04 runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v1
- uses: ammaraskar/sphinx-action@master
with: with:
path: nuttx docs-folder: "Documentation/"
fetch-depth: 1 - uses: actions/upload-artifact@v2
- 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
with: with:
name: htmldocs name: sphinx-docs
path: ./build/ path: Documentation/_build/html/

View File

@ -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 }}

View File

Before

Width:  |  Height:  |  Size: 4.8 KiB

After

Width:  |  Height:  |  Size: 4.8 KiB

View File

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

Before

Width:  |  Height:  |  Size: 5.7 KiB

After

Width:  |  Height:  |  Size: 5.7 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

@ -73,7 +73,7 @@ html_css_files = [
html_show_license = True html_show_license = True
html_logo = '../Documentation/NuttX.png' html_logo = '_static/NuttX.png'
html_favicon = '_static/favicon.ico' html_favicon = '_static/favicon.ico'
today_fmt = '%d %B %y at %H:%M' today_fmt = '%d %B %y at %H:%M'

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB