michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/doc/guides/index.rst

40 lines
702 B
ReStructuredText
Raw Normal View History

doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
.. _user_guides:
User and Developer Guides
#########################
.. toctree::
:maxdepth: 1
doc: guides: add "Asking for Help" guide I often wish I had a short and Zephyr-specific place to point people to when they're asking for help in ways that make it hard to help them. Add one. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-04-17 12:54:17 -06:00
getting-help.rst
doc: New developer getting started guide As presented to the TSC, Zephyr's out-of-box experience for new developers is, well, complicated. A number of suggestions were presented including simplifying the getting started material to present a straight-forward path through the setup and installation steps through to getting a sample application built, flashed, and running. This PR is a work-in-progress towards addressing this OOB experience with a minimal-distractions version of the GSG. Alternatives, warnings, and material that could lead the developer astray were moved to alternative/advanced instruction documents (based on the previous separate Linux/macOS/Windows setup guides) and a new "Beyond the GSG" document. We do take advantage of a sphinx-tabs extension for synchronized tabs to present OS-specific instructions: clicking on one tab will display all same-named tabs throughout the doc. We hope (and will continue evaluating) that this new GSG gets developers set up quickly and then we can send them along to other documents to continue learning about Zephyr and trying other sample apps. Thanks for all your previous feedback that I've worked into this new version. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-09-12 14:32:29 -07:00
beyond-GSG.rst
doc: ARC: add info page with Zephyr support status on ARC As of today, Zephyr misses any kind of info page with overall support status of ARC processors, their HW features and SW tools. Fix that. Signed-off-by: Eugeniy Paltsev <Eugeniy.Paltsev@synopsys.com>
2021-01-21 20:36:50 +03:00
arch/index.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
bluetooth/index.rst
doc: document python build scripts We have a collection of python scripts that are part of our build system. This PR collects docstring comments added to these scripts into a summary document. Previous references to just the script name in other documentation are updated to point to this build tool documentation. Some of the scripts needed an update to be processed (via include directives) consistently. Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-31 15:39:39 -07:00
build/index
doc: add coding guidelines Add the coding guidelines agreed upon by the project TSC with a description of the staged approach needed to implement them Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-06-27 09:21:48 -04:00
coding_guidelines/index
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
c_library
../README.rst
doc: Move Documentation Guidelines right after Documentation Generation List Documentation Guidelines right after Documentation Generation in the index for User and Developer Guides. Makes it easier to spot. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-17 15:56:58 +01:00
documentation/index
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
coccinelle.rst
code-relocation.rst
doc: add orphaned crypto docs tinycrypt documentation wasn't included in the table of contents so add it into the guides section. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-10 15:29:07 -07:00
crypto/index
doc: guides: debugging: Move to flash_debug dir The debugging section was generalized for flash and debugging tools. The links were refactored accordly and all references were updated. To be consistent, the directory doc/guides/debbugging was renamed to doc/guides/flash_debug. Signed-off-by: Gerson Fernando Budke <nandojve@gmail.com>
2020-11-06 18:46:49 -03:00
flash_debug/index
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
device_mgmt/index
device_mgmt/dfu
dts/index
doc: emulator: Add basic documentation Add some basic documentation for Zephyr emulators. This is expanded from https://github.com/zephyrproject-rtos/zephyr/issues/27531 and recent commits. Signed-off-by: Simon Glass <sjg@chromium.org>
2020-10-09 11:55:49 -06:00
emulator/index.rst
doc: unify documentation on setting environment variables There are a few different places where alternatives for setting environment variables are described. None of them is 100% complete, so the results are likely to be confusing. Make a single page on setting environment variables, how the zephyrrc files work, how the zephyr-env scripts work, and some of the important environment variables, with appropriate references elsewhere. (This is inspired by the Arch wiki's excellent page on installing programs.) Link to it from the getting started and application development pages instead of repeating the information. This has the benefit of shortening the getting started guide a bit more. Add some concrete advice on checking the toolchain environment variables in particular. This is a stumbling block for beginners. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-05-06 23:36:30 -06:00
env_vars.rst
doc: Add more coverage documentation Add more documentation about how to generate coverage reports for POSIX arch based boards Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
2019-02-20 16:04:14 +01:00
coverage.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
kconfig/index
doc: move module related doc to guides Move to a new guide which will expand on how to submit modules and how to maintain them. Also move topology documentation to repository management section where it fits better. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-10 10:27:59 -04:00
modules.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
networking/index
doc: Update PlatformIO guide Rephrase it in neutral tone so it won't seem like an endorsement Signed-off-by: Valerii Koval <valeros08@gmail.com>
2020-04-14 12:49:50 +03:00
platformio/index.rst
docs: add posix OS abstraction layer section Add section about the POSIX support in Zephyr. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-07-14 09:05:16 -04:00
portability/index.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-02 11:06:11 -05:00
porting/index
test/index
tracing/index
west/index
doc: guide for optimizing zephyr Add section about how to optimize Zephyr for footprint. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-03 09:02:50 -04:00
optimizations/index
doc: Update documentation to describe use of find_package(Zephyr) This commit changes the current boilerplate include description and instead describes the use of find_package(Zephyr) It also add a section covering additional possibilities when using find_package(Zephyr). - Search order - Zephyr repository application description - Zephyr workspace application description - Zephyr freestanding application description - Environment ZEPHYR_BASE setting - Multiple Zephyr and preference setting Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-03-12 23:34:12 +01:00
zephyr_cmake_package.rst
doc: add info about using thread local storage Adds a simple document on thread local storage. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2020-10-06 13:04:45 -07:00
thread_local_storage.rst
Copy permalink