Git Product home page Git Product logo

Comments (7)

Hello1024 avatar Hello1024 commented on March 29, 2024

The g3doc used in Tensorflow is, I believe, identical to Markdown. If you find anything that doesn't meet the markdown specification, file an issue.

from tensorflow.

kmatzen avatar kmatzen commented on March 29, 2024

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.

from tensorflow.

martinwicke avatar martinwicke commented on March 29, 2024

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.

from tensorflow.

varun19299 avatar varun19299 commented on March 29, 2024

Is there a blog post or guide out for this yet?

from tensorflow.

martinwicke avatar martinwicke commented on March 29, 2024

Check out the documentation authoring guide: https://www.tensorflow.org/community/documentation

from tensorflow.

varun19299 avatar varun19299 commented on March 29, 2024

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.

from tensorflow.

martinwicke avatar martinwicke commented on March 29, 2024

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.

from tensorflow.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.