diff options
| author |  Mark Daoust <markdaoust@google.com> | 2018-08-09 07:03:39 -0700 |
|---|---|---|
| committer |  TensorFlower Gardener <gardener@tensorflow.org> | 2018-08-09 07:08:30 -0700 |
| commit | f40a875355557483aeae60ffcf757fc9626c752b (patch) | |
| tree | 7f642a6fd12495c1c7d9b2f3a37e376d8ee6d2c9 /tensorflow/g3doc/README.txt | |
| parent | fd9fc4b4b69f7fce60497bbaf5cbd958f12ead8d (diff) | |
Remove usage of magic-api-link syntax from source files.
Back-ticks are now converted to links in the api_docs generator. With the new docs repo we're moving to simplify the docs pipeline, and make everything more readable.
By doing this we no longer get test failures for symbols that don't exist (`tf.does_not_exist` will not get a link).
There is also no way, not to set custom link text. That's okay.
This is the result of the following regex replacement (+ a couple of manual edits.):
re: @\{([^$].*?)(\$.+?)?}
sub: `\1`
Which does the following replacements:
"@{tf.symbol}" --> "`tf.symbol`"
"@{tf.symbol$link_text}" --> "`tf.symbol`"
PiperOrigin-RevId: 208042358
Diffstat (limited to 'tensorflow/g3doc/README.txt')
| -rw-r--r-- | tensorflow/g3doc/README.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/tensorflow/g3doc/README.txt b/tensorflow/g3doc/README.txt index ed648f8b6b..515a9e9a02 100644 --- a/tensorflow/g3doc/README.txt +++ b/tensorflow/g3doc/README.txt @@ -22,12 +22,12 @@ When authoring docs, note that we have some new syntax for references -- at least for docs coming from Python docstrings or tensorflow/docs_src/. Use: -* @{tf.symbol} to make a link to the reference page for a Python +* `tf.symbol` to make a link to the reference page for a Python symbol. Note that class members don't get their own page, but the - syntax still works, since @{tf.MyClass.method} links to the right + syntax still works, since `tf.MyClass.method` links to the right part of the tf.MyClass page. -* @{tensorflow::symbol} to make a link to the reference page for a C++ +* `tensorflow::symbol` to make a link to the reference page for a C++ symbol. (This only works for a few symbols but will work for more soon.) * @{$doc_page} to make a link to another (not an API reference) doc |