https://github.com/lttng/lttng-docs

The LTTng Documentation: Source (official repository)
https://github.com/lttng/lttng-docs

Last synced: 3 months ago
JSON representation

The LTTng Documentation: Source (official repository)

• Host: GitHub
• URL: https://github.com/lttng/lttng-docs
• Owner: lttng
• Created: 2014-05-28T18:11:39.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-09T18:47:12.000Z (6 months ago)
• Last Synced: 2024-07-16T14:07:41.358Z (4 months ago)
• Language: Python
• Homepage: http://lttng.org/docs
• Size: 3.54 MB
• Stars: 67
• Watchers: 9
• Forks: 35
• Open Issues: 8
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.adoc

Awesome Lists containing this project

README

        
The LTTng Documentation: Source

===============================

This is the official repository of the

http://lttng.org/docs[online LTTng Documentation's] source.

== Generate

You can generate your own version of the LTTng Documentation by running:

----

make

----

The generated HTML file is named

+__VERSION__/lttng-docs-__VERSION__.html+, where +__VERSION__+ is the

version of the LTTng project documented by this file.

You can also make a specific version:

----

make 2.7

----

NOTE: The SVG animations rendered on the LTTng website are not

available in the generated version.

You need the following tools to generate the LTTng Documentation:

* http://www.methods.co.nz/asciidoc/[AsciiDoc] >= 8.6.5

* http://pygments.org/[Pygments] and the `pygmentize` command

== Contribute

To contribute:

. Fork this repo.

. Make your change, following the link:CONTRIBUTING.adoc[contributor's guide].

. Create a pull request.

Thanks for your contributions and fixes!