Google Git
Sign in
pigweed / pigweed / pigweed / 72cae432f5dd9c5a728b224d2f1a84efcff6bd8c
commit72cae432f5dd9c5a728b224d2f1a84efcff6bd8c[log] [tgz]
authorKeir Mierle <keir@google.com>Sat Apr 10 02:03:40 2021 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Apr 28 22:59:21 2021 +0000
tree4e8c3ea14572a0c2446fd8316cdf382476be03ce
parentef95c6fd96fd3478b0d6e745c2128a6d20301fa8 [diff]
docs: Migrate MD to RST

This migrates our legacy Markdown to Restructured Text (RST). Now that
we have a website, we don't have to rely on rendering our docs on Gerrit
and GitHub, and can instead point at our webpage. This enables

1. Upgrading to a new Sphinx - our current version is 2 years old.
2. Using more sophisticated constructs like "note"
3. Adding custom CSS rules

Change-Id: I8153322efbcb307c1ca1ee3392b67f30f365f78c
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/40480
Reviewed-by: Armando Montanez <amontanez@google.com>
Commit-Queue: Keir Mierle <keir@google.com>
Pigweed-Auto-Submit: Keir Mierle <keir@google.com>
9 files changed
tree: 4e8c3ea14572a0c2446fd8316cdf382476be03ce
  1. build_overrides/
  2. docker/
  3. docs/
  4. pw_allocator/
  5. pw_arduino_build/
  6. pw_assert/
  7. pw_assert_basic/
  8. pw_assert_log/
  9. pw_base64/
  10. pw_bloat/
  11. pw_blob_store/
  12. pw_boot_armv7m/
  13. pw_build/
  14. pw_bytes/
  15. pw_checksum/
  16. pw_chrono/
  17. pw_chrono_embos/
  18. pw_chrono_freertos/
  19. pw_chrono_stl/
  20. pw_chrono_threadx/
  21. pw_cli/
  22. pw_containers/
  23. pw_cpu_exception/
  24. pw_cpu_exception_cortex_m/
  25. pw_docgen/
  26. pw_doctor/
  27. pw_env_setup/
  28. pw_fuzzer/
  29. pw_hdlc/
  30. pw_hex_dump/
  31. pw_i2c/
  32. pw_interrupt/
  33. pw_interrupt_cortex_m/
  34. pw_kvs/
  35. pw_log/
  36. pw_log_basic/
  37. pw_log_multisink/
  38. pw_log_null/
  39. pw_log_rpc/
  40. pw_log_sink/
  41. pw_log_tokenized/
  42. pw_malloc/
  43. pw_malloc_freelist/
  44. pw_metric/
  45. pw_minimal_cpp_stdlib/
  46. pw_module/
  47. pw_multisink/
  48. pw_package/
  49. pw_persistent_ram/
  50. pw_polyfill/
  51. pw_preprocessor/
  52. pw_presubmit/
  53. pw_protobuf/
  54. pw_protobuf_compiler/
  55. pw_random/
  56. pw_result/
  57. pw_ring_buffer/
  58. pw_router/
  59. pw_rpc/
  60. pw_span/
  61. pw_status/
  62. pw_stream/
  63. pw_string/
  64. pw_sync/
  65. pw_sync_baremetal/
  66. pw_sync_embos/
  67. pw_sync_freertos/
  68. pw_sync_stl/
  69. pw_sync_threadx/
  70. pw_sys_io/
  71. pw_sys_io_arduino/
  72. pw_sys_io_baremetal_lm3s6965evb/
  73. pw_sys_io_baremetal_stm32f429/
  74. pw_sys_io_stdio/
  75. pw_target_runner/
  76. pw_thread/
  77. pw_thread_embos/
  78. pw_thread_freertos/
  79. pw_thread_stl/
  80. pw_thread_threadx/
  81. pw_tokenizer/
  82. pw_tool/
  83. pw_toolchain/
  84. pw_trace/
  85. pw_trace_tokenized/
  86. pw_unit_test/
  87. pw_varint/
  88. pw_watch/
  89. pw_web_ui/
  90. targets/
  91. third_party/
  92. .dockerignore ⇨ .gitignore
  93. activate.sh ⇨ bootstrap.sh
  94. .bazelignore
  95. .bazelrc
  96. .clang-format
  97. .eslintrc.json
  98. .gitattributes
  99. .gitignore
  100. .gn
  101. .prettierrc.js
  102. .pylintrc
  103. activate.bat
  104. AUTHORS
  105. bootstrap.bat
  106. bootstrap.sh
  107. BUILD
  108. BUILD.gn
  109. BUILDCONFIG.gn
  110. CMakeLists.txt
  111. LICENSE
  112. modules.gni
  113. OWNERS
  114. package.json
  115. PW_PLUGINS
  116. README.md
  117. tsconfig.json
  118. WORKSPACE
  119. yarn.lock
README.md

See our website: http://pigweed.dev