testRST.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. .. index::
  2. single: directive ignored
  3. title_text
  4. ----------
  5. .. comment ignored
  6. ..
  7. comment ignored
  8. Command :cmake:command:`some_cmd` explicit cmake domain.
  9. Command :command:`some_cmd` without target.
  10. Command :command:`some_cmd <some_cmd>` with target.
  11. Command :command:`some_cmd_<cmd>` placeholder without target.
  12. Command :command:`some_cmd_<cmd> <some_cmd>` placholder with target.
  13. Command :command:`some_cmd()` with parens.
  14. Command :command:`some_cmd(SUB)` with subcommand.
  15. Command :command:`some_cmd(SUB) <some_cmd>` with subcommand and target.
  16. Command :command:`some_cmd (SUB) <some_cmd>` with space and subcommand and target.
  17. Command :command:`some command <some_cmd>` with space and target.
  18. Variable :variable:`some variable <some_var>` space and target.
  19. Variable :variable:`<PLACEHOLDER>_VARIABLE` with leading placeholder.
  20. Variable :variable:`VARIABLE_<PLACEHOLDER>` with trailing placeholder.
  21. Variable :variable:`<PLACEHOLDER>_VARIABLE <target>` with leading placeholder and target.
  22. Variable :variable:`VARIABLE_<PLACEHOLDER> <target>` with trailing placeholder and target.
  23. Generator :generator:`Some Generator` with space.
  24. .. |not replaced| replace:: not replaced through toctree
  25. .. |not replaced in literal| replace:: replaced in parsed literal
  26. .. toctree::
  27. :maxdepth: 2
  28. testRSTtoc1
  29. /testRSTtoc2
  30. .. cmake-module:: testRSTmod.cmake
  31. .. cmake:command:: some_cmd
  32. Command some_cmd description.
  33. .. command:: other_cmd
  34. Command other_cmd description.
  35. .. cmake:variable:: some_var
  36. Variable some_var description.
  37. .. variable:: other_var
  38. Variable other_var description.
  39. .. parsed-literal::
  40. Parsed-literal included without directive.
  41. Common Indentation Removed
  42. # |not replaced in literal|
  43. .. code-block:: cmake
  44. # Sample CMake code block
  45. if(condition)
  46. message(indented)
  47. endif()
  48. # |not replaced in literal|
  49. A literal block starts after a line consisting of two colons
  50. ::
  51. Literal block.
  52. Common Indentation Removed
  53. # |not replaced in literal|
  54. or after a paragraph ending in two colons::
  55. Literal block.
  56. Common Indentation Removed
  57. # |not replaced in literal|
  58. but not after a line ending in two colons::
  59. in the middle of a paragraph.
  60. .. productionlist::
  61. grammar: `production`
  62. production: "content rendered"
  63. .. note::
  64. Notes are called out.
  65. .. |substitution| replace::
  66. |nested substitution|
  67. with multiple lines becomes one line
  68. .. |nested substitution| replace:: substituted text
  69. .. include:: testRSTinclude1.rst
  70. .. include:: /testRSTinclude2.rst