Skip to content

RFC docs: style guide first sketchy draft #2062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

RFC docs: style guide first sketchy draft #2062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bda7ae
docs: import GitLab's style guide
silopolis Sep 19, 2022
8f2c8ba
docs: convert GitLab's style guide to AsciiDoc
silopolis Sep 19, 2022
72b9969
docs: style guide first sketchy draft
silopolis Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/src/attributes.inc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
:lversion: {sys: cat ../VERSION}
:lbranch: {sys: git rev-parse --abbrev-ref HEAD}

:date: {sys: LANG=C date --date="@$(dpkg-parsechangelog --file ../debian/changelog -S timestamp)" '+%d %b %Y'}
:revdate: {docdate}
:builddate: {localdate}

:experimental:
:masterdir: {indir}
:doctype: book
:ascii-ids:
:toc:
:lang: en

// Custom lang highlight
// must come after the doc title, to work around a bug in asciidoc 8.6.6
:ini: {basebackend@docbook:'':ini}
:hal: {basebackend@docbook:'':hal}
:ngc: {basebackend@docbook:'':ngc}
:css: {basebackend@docbook:'':css}

:wlo-url: https://www.linuxcnc.org
:wlo: {wlo-url}[LinuxCNC website]
:ldocs-url: {wlo-url}/documents
:ldocs: {ldocs-url}[LinuxCNC documentation]
:ldocs-base-html: {docs-base}/{branch}/{lang}/html/
:ldocs-base-pdf: {docs-base}/{branch}/{lang}/pdf/
:lrepo-url: https://github.com/LinuxCNC/linuxcnc.git
:lrepo: {lrepo-url}[LinuxCNC repository]
:lbbot-url: http://buildbot.linuxcnc.org/
:lbbot: {lbbot-url}[LinuxCNC Builbot]
Loading