Apache NuttX Website

Clone this repo:
  1. d943dbf CI: Add documentation on triggering the workflow by Brennan Ashton · 11 days ago master
  2. 36f9d16 Docs: Use pipenv to drive CI Sphinx build by Brennan Ashton · 2 weeks ago
  3. 9462e9e Add build step to save the static generated site for review by Brennan Ashton · 4 weeks ago
  4. 9585444 Add logic for publishing documentation from sphinx docs by Brennan Ashton · 4 weeks ago
  5. 52ac5e9 Add release 9.1.0 to releases page by Brennan Ashton · 8 weeks ago

How to update the project's web site

Running locally

Before opening a pull request, you can preview your contributions by running from within the directory:

1. bundle exec jekyll serve
2. Open [http://localhost:4000](http://localhost:4000)

Pushing to site

Site is updated by a CI job that runs the publish.sh script. Once this runs it the results will be visible https://nuttx.apache.org.

Force Deployment

If a dependency has changed such as the external documentation you may need to force the deployment CI to run. This can be done from the CI Actions tab and selecting Run workflow -> Branch: master --> Run workflow

Trigger Workflow

Adding contributors

To add a contributor to the project, or to modify existing contributors, edit site/_data/contributors.yml. The project members list will re-generate.