Repository navigation
g3doc format #14
Description
Activity
I mean the comments in the C++ that are used to generate the markdown files.
Example:
https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/public/env.h#L47/// \brief Returns a default environment suitable for the current operating /// system. /// /// Sophisticated users may wish to provide their own Env /// implementation instead of relying on this default environment. /// /// The result of Default() belongs to this library and must never be deleted. static Env* Default();is used to generate
* [`static Env* tensorflow::Env::Default()`](#static_Env_tensorflow_Env_Default) * Returns a default environment suitable for the current operating system.and
#### `static Env* tensorflow::Env::Default()` {#static_Env_tensorflow_Env_Default} Returns a default environment suitable for the current operating system. Sophisticated users may wish to provide their own Env implementation instead of relying on this default environment. The result of Default() belongs to this library and must never be deleted.My point is that the docs were pre-generated. I can't find another project where Google has open sourced the g3doc utility so that others may rerun it and update the documentation.
If the answer is "the syntax is just like doxygen", then that's an acceptable answer, although it would still be nice to be given the same tool to generate the markdown.
The syntax is, in fact, doxygen: part of our docs generation pipeline calls doxygen. We are working on making more of the doc generator publicly available, but it requires a decent amount of untangling.
- added a commit that references this issue
on Mar 9, 2016 - added a commit that references this issue
on Apr 6, 2017 - added a commit that references this issue
on Jun 20, 2017 Is there a blog post or guide out for this yet?
Check out the documentation authoring guide: https://www.tensorflow.org/community/documentation
Is the engine now open source though? (If I didn't want to build it specifically as a part of tensorflow docs, rather use it for my own markdown rendering )?
This video (dated 2016) is really fascinating in concept. It would be great if the whole system were fully elaborated upon.
Everything from TensorFlow source code to markdown is open-source. It should be usable for other projects, although the code may have aspects specific to TensorFlow which may not trivial to extract.
TensorFlow docs are not served using g3docs. I cannot speak to the specifics of that presentation.
- added a commit that references this issue
on Dec 6, 2019 - added a commit that references this issue
on Aug 28, 2020 13 remaining items
- added 5 commits that reference this issue
on Apr 9, 2025 - added 5 commits that reference this issue
on Jul 28, 2025 - added a commit that references this issue
on Nov 26, 2025
Has the g3doc specification been publicly released? Is an effort going to be made so that outside contributors know exactly how comments should be written in order to be correctly parsed?