amd64 configure needs explicit options as for now#62
Closed
sirop wants to merge 1 commit intomachinekit:masterfrom
sirop:patch-3
Closed
amd64 configure needs explicit options as for now#62sirop wants to merge 1 commit intomachinekit:masterfrom sirop:patch-3
sirop wants to merge 1 commit intomachinekit:masterfrom
sirop:patch-3
Conversation
`./configure` needs explicit options as otherwise Xenomai kernel modules are also built. Like: ``` LD [M] /home/cml/machinekit-build-test/src/objects/xenomai-kernel/3.8-1-xenomai.x86-amd64/wcomp.ko LD [M] /home/cml/machinekit-build-test/src/objects/xenomai-kernel/3.8-1-xenomai.x86-amd64/wcompn.ko LD [M] /home/cml/machinekit-build-test/src/objects/xenomai-kernel/3.8-1-xenomai.x86-amd64/weighted_sum.ko LD [M] /home/cml/machinekit-build-test/src/objects/xenomai-kernel/3.8-1-xenomai.x86-amd64/xhc_hb04_util.ko LD [M] /home/cml/machinekit-build-test/src/objects/xenomai-kernel/3.8-1-xenomai.x86-amd64/xor2.ko ``` That is at least confusing. Tested on wheezy: ``` cml@debian-cml2:~/machinekit-build-test$ uname -a Linux debian-cml2 3.8-1-xenomai.x86-amd64 #1 SMP Debian 3.8.13-9 x86_64 GNU/Linux cml@debian-cml2:~/machinekit-build-test$ git log | head -5 commit 8bbcdfb0a6e7ffeadcc2553272f4b116581dc1eb Merge: 1200f35 8305c46 Author: cdsteinkuehler <charles@steinkuehler.net> Date: Fri Mar 11 14:30:50 2016 -0600 ```
mhaberler
added a commit
to mhaberler/machinekit-docs
that referenced
this pull request
Jun 19, 2016
314b080 Merge pull request machinekit#62 from mhaberler/master 017ce0a Makefile: make template path configurable, depend on all moving parts git-subtree-dir: machinetalk-protobuf git-subtree-split: 314b080
mhaberler
pushed a commit
to mhaberler/machinekit-docs
that referenced
this pull request
Jun 19, 2016
Makefile: make template path configurable, depend on all moving parts
machinekoder
pushed a commit
to machinekoder/machinekit-docs
that referenced
this pull request
Jul 13, 2016
* move into docs subdir: mkdir docs, git mv man1 man3 man9 docs
* add-frontmatter Python script
Signed-off-by: Michael Haberler <git@mah.priv.at>
* apply conversion: find . -name '*.asciidoc' -exec scripts/addfm.py {} \;
* move to docs/man
duh
Signed-off-by: Michael Haberler <git@mah.priv.at>
* _config.yml: exclude manpage extensions
* nah.. fix _config.yml
* more of same. This SUCKS.
* remove nroff source files.
let's let them live in the mk/mk repo
* add jenkins status icon
* Update README.md
* Update README.md
* Update README.md
* Update README.md
* clenaup: exlcude, remove more files so they do not seep into _site
* Scripted indexes for man pages
index-gen.sh added to generate index docs on the fly at each build
from a Makefile
docs/index.asciidoc amended to promote reading of docs not asking help
_config.yml edit to switch on incremental builds
Entire docs/components dir deleted as these now are generated in docs/man/man9
Signed-off-by: Mick <arceye@mgware.co.uk>
* Auto generation man page indexes - Pt2
index-gen.sh amended to output the paths relative to the top level index-HAL.asciidoc
This is now the sole portal to the HAL Man Pages and the complexity of getting paths
right under jekyll, means this is how they have to be output, even if that means the
generated index.html not being stand alone.
Makefile added to automate the scripting of the indexes
All 3 man types now generated and accessible from index-HAL.asciidoc
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update README.md
* Pointless edit to trigger rebuild and test Makefile
* Test absolute address in links
Links generated in index docs are failing to be shown
Substitute abs links to see if it is these links, or the link to the index doc itself that is not being found
* Change relative includes to abs links
Second part of test to find why generated man page indexes which display perfectly locally do not display on
remote site, despite all files being present
* Revert abs path changes to index-gen script
* Revert absolute links changes in index-HAL.asciidoc
* fix man index path
* docs: add man categories
* man section names: do not overflow right column
* Remove old index to components
Redirect links to the man page index for components
Signed-off-by: Mick <arceye@mgware.co.uk>
* index-HAL - remove man references
* gitignore generated index files
* fix broken links
* fix some more links
* and some more
* and some more
* remove typos
* Create Sandbox for ad hoc contributions
Make it accessable solely through 'Edit this Page' link
to reduce bar to minimum
Signed-off-by: Mick <arceye@mgware.co.uk>
* Test article into Sandbox
Test functionality of posting articles, solely using the 'Edit this Page' link
* Test Article for Sandbox
testing 2nd stage of process
* SandBox tidy up
* Rename sandbox template files names to numbers to aid scripting
Signed-off-by: Mick <arceye@mgware.co.uk>
* Add scripts/filenums
Automatically create extra sandbox templates when less than 5
remaining
Run at each rebuild
Signed-off-by: Mick <arceye@mgware.co.uk>
* Added index.asciidoc updating to filenums script
Whoops forgot!
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update sitemap generation to produce absolute URLs
Google rejecting relative ones
Signed-off-by: Mick <arceye@mgware.co.uk>
* Change SandBox URL to absolute to ensure it works from anywhere
Signed-off-by: Mick <arceye@mgware.co.uk>
* Fix broken links
2 .png files completely missing, 'borrowed with pride' from
linuxcnc repo
Multiple broken links caused by files being included into main
indexes, but being visible by other routes, whence the relative URLs in links
are wrong
Fixed all with absolute links, sick of messing around with them
Signed-off-by: Mick <arceye@mgware.co.uk>
* Link fix Pt 2
Signed-off-by: Mick <arceye@mgware.co.uk>
* Links fix Pt3
Signed-off-by: Mick <arceye@mgware.co.uk>
* Links fix 4
Get rid of intransigent circular fault caused by includes
Signed-off-by: Mick <arceye@mgware.co.uk>
* All link errors have been removed, but 8 which relate to the same
non-existent link persist
Change build to remove incremental, to get rid of cache effect
Signed-off-by: Mick <arceye@mgware.co.uk>
* No easy way into the Developing docs
Created a sidebar entry and index
Signed-off-by: Mick <arceye@mgware.co.uk>
* Keep forgetting jekyll creates dirs instead of files
Try 2 with develop-index
Signed-off-by: Mick <arceye@mgware.co.uk>
* docs sidebar: add sections and shuffle subjects around
* develop-index.asciidoc: add bullets to increase readablilty
* Edit link name
I already changed this once, but somehow it reverted
* Switch order of topics in 'For Starters' doc side bar
Signed-off-by: Mick <arceye@mgware.co.uk>
* fixup edit-repo and edit-branch to point to mk/mk-docs
* analytics.html: include only if production site is built
so preview results are not measured
* fix icons, and trigger a merge event
* New CSE preparation
Remove old google search tag
Edit all absolute URLs to preview.machinekit.io, to machinekit.io
Signed-off-by: Mick <arceye@mgware.co.uk>
* New CSE and google verification details required pre-indexing
Signed-off-by: Mick <arceye@mgware.co.uk>
* New search engine refs for site
Signed-off-by: Mick <arceye@mgware.co.uk>
* hardwired site refs: drop
this makes it impossible to render to different toplevel sites without
generating undesirable cross-site links
* scripts: recursive replace example
* _config.yml: remove url:
* fix "wiki.machinekit.org" links
* fix a few broken links
* use edit-me to patch this up ;)
* remove unused html directory
is copied to site, confuses linkchecker
* add a default linkcheckerrc so it can be pointed to with --config=/scripts/linkcheckerrc
* replace docs/* link:../ with link:/docs
* make :imagesdir: paths absolute
* remove CNAME in topdir - should be inserted build-time
confuses github when forking this repo
* fix some more bad image links
* more link unbreaking - unsure how this escapes the linkchecker
* switch Google Analytics ID from preview.machinekit.io to www.machinekit.io
* one more..
* one more of own turds..
* README: add reference to site
* docs/README: remove obsolete file
* docs/basic_hal.asciidoc: make diagram example and improve `net`
- removal of images
- addition od blockdiag example
- various improvements on `net` explanation
* fix images dirs
* Update basic_hal.asciidoc
* Update to SandBox blurb
Edited for brevity and include link to asciidoc guide
* Makefile: minimal rebuild - dont touch asciidoc files if not necessary
Mick - would you look into scripts/filenum such it does not touch or
regenerate files if not needed?
all updates - needed or not - go against preview delay
* fix hal_exit(3)
* Update hal_init.3hal.asciidoc
* Update hal_create_thread.3hal.asciidoc
* Update halrun.1.asciidoc
* start over on docs/documenting/diagramtest example
* Update building-rt-preempt-kernel.asciidoc
Clarify how to build 64 bit kernel and update tested kernel versions
* now diagramtest fixups with edit-this-page..
* enable youtube, asciinema, toc plugins
* demo asciinema, youtube (broken), gist
* end passthrough block properly
* edit-me: add picture picture
* documenting.asciidoc: update instructions edit-me link
* dragramtest: rename to diagram-examples
* diagramtest: rename to diagram-examples
* documenting: update index, links and examples
* cleanup: remove out-of-date buildbot information
* highlighting: import jekyll-pygments-themes
from https://github.com/jwarby/jekyll-pygments-themes
* _config.yml: set pygments as default highlighter, style
* diagram-examples: fix source highlighting
* docs/site/about-this-site: first cut
* touchups
this needs some diagrams ;)
* add sandbox, issues, a bit of howto
* touchups
* _data/docs.yml: add reference to "about-this-site"
* improve examples
* add missing plugins
* add Guardfile for livereload
* scripts/serve.sh: run the jeykyll-asciidoctor stack for serving in a container
script needs editing first
* plugins: touchups
* diagram-examples: touchups
* nah. unbug serve.sh
* Update about-this-site.asciidoc
Correct typos
* do not overspecify intra-site URI's
or they can never be previewed
* Update instcomp.asciidoc
Correct typos ( some of which will not be typos when the ck-integration work finally hits mainstream and will require changing again )
* tickle build
* Add RPi 2/3
Add info about RPi models, that work with this. These are the models RPi 2 and RPi 3.
* Overhaul the indexes
HAL, Developer, User and Getting Started
Index document references subsiduary documents as links not includes
Index document does however include TOC for subsiduary documents,
but as links.
Each subsiduary document also has TOC to continue contents visibility
at lower levels no matter how the document was arrived at
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update to Integrator and Documenting Indexes
Update to remove includes and add TOC to all sub docs
Mass edit of all docs to set [source] tags before source sections
A lot of legacy docs did not use them and code was not displaying
in highlight
Fix missing :ignore-front-matter: tag to 2 documents which were not being
rendered at all
Change source highlighter to more muted yellow/green shade
Adjust the [NOTE] bar colours (improved but not there yet)
Remove some references to distro CD etc from legacy LCNC docs
Signed-off-by: Mick <arceye@mgware.co.uk>
* Modify style sheet to achieve proper contrast between text and background.
Existing style rendered backgrounds in muddy grey with black test,
which made for difficult reading.
Tables and Warnings were particularly bad
All graphic text backgrounds changed to a high contrast pale violet.
[NOTE] colours changed to a more restful pale blue
[WARNING] upgraded to the same type of banner as [NOTE] with muted red
background
To see all above plus [source] highlighting, see
preview.machinekit.io/docs/config/ini_config
which contains the lot.
Goes a long way to fix machinekit#144
Signed-off-by: Mick <arceye@mgware.co.uk>
* Fix visibility of some [NOTE] banners
A peculiar issue with this method of asciidoc to html conversion
in respect of [NOTE]
If the admonition block favoured by asciidoctor is used
[NOTE]
====
Text in here
====
It will be rendered in a white foreground, which is very difficult to read.
If however it is written as per asciidoc, which the legacy docs are
[NOTE]
Text here
The text is rendered in a black foreground and easily legible
A third method used in some legacy docs fails to render properly
with everything after a line break omitted and
back in the page text again
[NOTE]
//__=================================
Big block of text
Another block of text
//__================================
Various docs edited to make NOTE banners easily legible and ensure
the text intended to be displayed in them is so displayed (unless as in
one case there was so much of it, it was a page section not a note)
Signed-off-by: Mick <arceye@mgware.co.uk>
* Fully document Axis GUI enhancements
Add specific doc covering enhancements made to Axis in Machinekit
and add links in existing Axis docs
Signed-off-by: Mick <arceye@mgware.co.uk>
* Updated imagesdir to reflect path of images folder
* Fixed image paths in halui_examples
* Fixed images pahts in pyvpc_examples
* some repair on gladevcp.asciidoc
man is this edited to death
* gcode.asciidoc: this commented FIXME section breaks the page
* basic_hal.asciidoc: now correctly documents 64 bit floats
* diagram-examples.asciidoc: add PlantUML examples
* Makefile: support different output formats
example use:
make docs DOCFORMAT=markdown DOCEXT=md DOC_TARGET=tmp/foo.md
make docs DOCFORMAT=asciidoc DOCEXT=asciidoc DOC_TARGET=tmp/foo.asciidoc
this will use scripts/markdown.mustache and scripts/asciidoc.mustache
respectively
* scripts/asciidoc.mustache: a start - this is still markdown
needs to be rewritten for asciidoc
* add Python examples and install README
* Update README.md
* add support for livereload if Jekyll environment=development
use this gist for trying it: https://gist.github.com/mhaberler/ede68eae275c38a5364734c065a1b9c0
the serve.sh script has no place here - remove
* fix plugins.asciidoc
* deprecate old search links
* Update asciidoc.mustache
Produce asciidoc which is compatible for producing docs with asciidocor used in the website generation
Added file descriptions capability.
* Update APT-packages-jessie.asciidoc
After several re-installations from scratch today I never needed the instructions for libczmq, neither did I need to install it. It might have come for free when installing machinekit, but not sure.
There may be a need to install libczmq/-dev under certain circumstances - I don't know, but for a beginner that just want to run machinekit this installation is not needed.
* Squashed 'machinetalk-protobuf/' content from commit 05de663
git-subtree-dir: machinetalk-protobuf
git-subtree-split: 05de663
* Makefile: make template path configurable, depend on all moving parts
* scripts/gen-proto-docs.sh: pass along template path
* scripts/machinekit-docs.mustache: keep template in mk-docs repo
this simpler to manage than subtree updates
* _config.yml: ignore machinetalk-protobuf subtree
* Makefile: generate protobuf.asciidoc from template and subtree
* Squashed 'machinetalk-protobuf/' changes from 05de663..314b080
314b080 Merge pull request machinekit#62 from mhaberler/master
017ce0a Makefile: make template path configurable, depend on all moving parts
git-subtree-dir: machinetalk-protobuf
git-subtree-split: 314b080
* protobuf.asciidoc: generate target path
* scripts/gen-proto-docs.sh: pass along template path
* scripts/machinekit-docs.mustache: keep template in mk-docs repo
this simpler to manage than subtree updates
* _config.yml: ignore machinetalk-protobuf subtree
* Makefile: generate protobuf.asciidoc from template and subtree
* protobuf.asciidoc: generate target path
* tickle build
* diagram-examples: move highlighting to separate page, adapt links
* tickle build
when two repos are used, the PR builder becomes schizo and doesnt know with SHA to build - trying to figure
* diagrams: make wavedrom use svg instead of png, link to article
* Add QtQuickVcp documentation to site docs
Add link in sidebar and developing indicies
Adapted from repo readme.md
Doubtless capable of polishing:)
Signed-off-by: Mick <arceye@mgware.co.uk>
* Shorten First level title
This is used as title of link in right hand bar entry and needs to be briefer
Signed-off-by: Mick <arceye@mgware.co.uk>
* python-interface: touch up
* kick website-production jenkins job
maybe this does the trick
* Move Search-Bar to primary navigation items for all pages
(top of page)
Remove side bar and front page implementations
Signed-off-by: Mick <arceye@mgware.co.uk>
* hal_pru_generic: import man page from Charles' repo
wget https://raw.githubusercontent.com/cdsteinkuehler/linuxcnc/18ee2e8445d1ef73a17f62d79af465ee4f020fb8/man/man9/hal_pru_generic.9.asciidoc
* hal_pru_generic: cosmetic touchups
* infra: a first stab at repos & flows descriptions
* Capitalise and shorten top level header title
Used as menu link in docs sidebar and needed to be shorter
* fix typo in Makefile
* Amend docs_contents to exclude from google searches
Now that searches are fully seeded, there are a lot of hits coming
from crawlers finding 'boiler plate' sidebar links and including
those
eg. Search `HAL` and the `Hal Utilities and GUIs` link keeps appearing.
First stage is to wrapper in a 'nocontent' div
Once in place I can change the cse.xml to activate it and eventually
the crawlers will exclude it on new crawls.
Signed-off-by: Mick <arceye@mgware.co.uk>
* Delete edittest-adxl345.asciidoc
* diagram-examples: add Google Charts example
* infra: clarify which repos are involved
* index-documenting: fix title
* repositiories: fix typos, expand on mksocfpga, jenkins
* fix typo
* Move `Edit This Page` and `Sandbox` links to navigation area
onto same line as `Search`
The increase in RH sidebar items has pushed these items further down
the page
Moving them makes the layout more coherent, sidebar is for quick access
links to major topics
The navigation list keeps 'Edit this page' in particular, immediately
available and obvious from any page in the site
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update gcode.asciidoc
Added links to example files
machinekoder
pushed a commit
to machinekoder/machinekit-docs
that referenced
this pull request
Jul 13, 2016
* move into docs subdir: mkdir docs, git mv man1 man3 man9 docs
* add-frontmatter Python script
Signed-off-by: Michael Haberler <git@mah.priv.at>
* apply conversion: find . -name '*.asciidoc' -exec scripts/addfm.py {} \;
* move to docs/man
duh
Signed-off-by: Michael Haberler <git@mah.priv.at>
* _config.yml: exclude manpage extensions
* nah.. fix _config.yml
* more of same. This SUCKS.
* remove nroff source files.
let's let them live in the mk/mk repo
* add jenkins status icon
* Update README.md
* Update README.md
* Update README.md
* Update README.md
* clenaup: exlcude, remove more files so they do not seep into _site
* Scripted indexes for man pages
index-gen.sh added to generate index docs on the fly at each build
from a Makefile
docs/index.asciidoc amended to promote reading of docs not asking help
_config.yml edit to switch on incremental builds
Entire docs/components dir deleted as these now are generated in docs/man/man9
Signed-off-by: Mick <arceye@mgware.co.uk>
* Auto generation man page indexes - Pt2
index-gen.sh amended to output the paths relative to the top level index-HAL.asciidoc
This is now the sole portal to the HAL Man Pages and the complexity of getting paths
right under jekyll, means this is how they have to be output, even if that means the
generated index.html not being stand alone.
Makefile added to automate the scripting of the indexes
All 3 man types now generated and accessible from index-HAL.asciidoc
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update README.md
* Pointless edit to trigger rebuild and test Makefile
* Test absolute address in links
Links generated in index docs are failing to be shown
Substitute abs links to see if it is these links, or the link to the index doc itself that is not being found
* Change relative includes to abs links
Second part of test to find why generated man page indexes which display perfectly locally do not display on
remote site, despite all files being present
* Revert abs path changes to index-gen script
* Revert absolute links changes in index-HAL.asciidoc
* fix man index path
* docs: add man categories
* man section names: do not overflow right column
* Remove old index to components
Redirect links to the man page index for components
Signed-off-by: Mick <arceye@mgware.co.uk>
* index-HAL - remove man references
* gitignore generated index files
* fix broken links
* fix some more links
* and some more
* and some more
* remove typos
* Create Sandbox for ad hoc contributions
Make it accessable solely through 'Edit this Page' link
to reduce bar to minimum
Signed-off-by: Mick <arceye@mgware.co.uk>
* Test article into Sandbox
Test functionality of posting articles, solely using the 'Edit this Page' link
* Test Article for Sandbox
testing 2nd stage of process
* SandBox tidy up
* Rename sandbox template files names to numbers to aid scripting
Signed-off-by: Mick <arceye@mgware.co.uk>
* Add scripts/filenums
Automatically create extra sandbox templates when less than 5
remaining
Run at each rebuild
Signed-off-by: Mick <arceye@mgware.co.uk>
* Added index.asciidoc updating to filenums script
Whoops forgot!
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update sitemap generation to produce absolute URLs
Google rejecting relative ones
Signed-off-by: Mick <arceye@mgware.co.uk>
* Change SandBox URL to absolute to ensure it works from anywhere
Signed-off-by: Mick <arceye@mgware.co.uk>
* Fix broken links
2 .png files completely missing, 'borrowed with pride' from
linuxcnc repo
Multiple broken links caused by files being included into main
indexes, but being visible by other routes, whence the relative URLs in links
are wrong
Fixed all with absolute links, sick of messing around with them
Signed-off-by: Mick <arceye@mgware.co.uk>
* Link fix Pt 2
Signed-off-by: Mick <arceye@mgware.co.uk>
* Links fix Pt3
Signed-off-by: Mick <arceye@mgware.co.uk>
* Links fix 4
Get rid of intransigent circular fault caused by includes
Signed-off-by: Mick <arceye@mgware.co.uk>
* All link errors have been removed, but 8 which relate to the same
non-existent link persist
Change build to remove incremental, to get rid of cache effect
Signed-off-by: Mick <arceye@mgware.co.uk>
* No easy way into the Developing docs
Created a sidebar entry and index
Signed-off-by: Mick <arceye@mgware.co.uk>
* Keep forgetting jekyll creates dirs instead of files
Try 2 with develop-index
Signed-off-by: Mick <arceye@mgware.co.uk>
* docs sidebar: add sections and shuffle subjects around
* develop-index.asciidoc: add bullets to increase readablilty
* Edit link name
I already changed this once, but somehow it reverted
* Switch order of topics in 'For Starters' doc side bar
Signed-off-by: Mick <arceye@mgware.co.uk>
* fixup edit-repo and edit-branch to point to mk/mk-docs
* analytics.html: include only if production site is built
so preview results are not measured
* fix icons, and trigger a merge event
* New CSE preparation
Remove old google search tag
Edit all absolute URLs to preview.machinekit.io, to machinekit.io
Signed-off-by: Mick <arceye@mgware.co.uk>
* New CSE and google verification details required pre-indexing
Signed-off-by: Mick <arceye@mgware.co.uk>
* New search engine refs for site
Signed-off-by: Mick <arceye@mgware.co.uk>
* hardwired site refs: drop
this makes it impossible to render to different toplevel sites without
generating undesirable cross-site links
* scripts: recursive replace example
* _config.yml: remove url:
* fix "wiki.machinekit.org" links
* fix a few broken links
* use edit-me to patch this up ;)
* remove unused html directory
is copied to site, confuses linkchecker
* add a default linkcheckerrc so it can be pointed to with --config=/scripts/linkcheckerrc
* replace docs/* link:../ with link:/docs
* make :imagesdir: paths absolute
* remove CNAME in topdir - should be inserted build-time
confuses github when forking this repo
* fix some more bad image links
* more link unbreaking - unsure how this escapes the linkchecker
* switch Google Analytics ID from preview.machinekit.io to www.machinekit.io
* one more..
* one more of own turds..
* README: add reference to site
* docs/README: remove obsolete file
* docs/basic_hal.asciidoc: make diagram example and improve `net`
- removal of images
- addition od blockdiag example
- various improvements on `net` explanation
* fix images dirs
* Update basic_hal.asciidoc
* Update to SandBox blurb
Edited for brevity and include link to asciidoc guide
* Makefile: minimal rebuild - dont touch asciidoc files if not necessary
Mick - would you look into scripts/filenum such it does not touch or
regenerate files if not needed?
all updates - needed or not - go against preview delay
* fix hal_exit(3)
* Update hal_init.3hal.asciidoc
* Update hal_create_thread.3hal.asciidoc
* Update halrun.1.asciidoc
* start over on docs/documenting/diagramtest example
* Update building-rt-preempt-kernel.asciidoc
Clarify how to build 64 bit kernel and update tested kernel versions
* now diagramtest fixups with edit-this-page..
* enable youtube, asciinema, toc plugins
* demo asciinema, youtube (broken), gist
* end passthrough block properly
* edit-me: add picture picture
* documenting.asciidoc: update instructions edit-me link
* dragramtest: rename to diagram-examples
* diagramtest: rename to diagram-examples
* documenting: update index, links and examples
* cleanup: remove out-of-date buildbot information
* highlighting: import jekyll-pygments-themes
from https://github.com/jwarby/jekyll-pygments-themes
* _config.yml: set pygments as default highlighter, style
* diagram-examples: fix source highlighting
* docs/site/about-this-site: first cut
* touchups
this needs some diagrams ;)
* add sandbox, issues, a bit of howto
* touchups
* _data/docs.yml: add reference to "about-this-site"
* improve examples
* add missing plugins
* add Guardfile for livereload
* scripts/serve.sh: run the jeykyll-asciidoctor stack for serving in a container
script needs editing first
* plugins: touchups
* diagram-examples: touchups
* nah. unbug serve.sh
* Update about-this-site.asciidoc
Correct typos
* do not overspecify intra-site URI's
or they can never be previewed
* Update instcomp.asciidoc
Correct typos ( some of which will not be typos when the ck-integration work finally hits mainstream and will require changing again )
* tickle build
* Add RPi 2/3
Add info about RPi models, that work with this. These are the models RPi 2 and RPi 3.
* Overhaul the indexes
HAL, Developer, User and Getting Started
Index document references subsiduary documents as links not includes
Index document does however include TOC for subsiduary documents,
but as links.
Each subsiduary document also has TOC to continue contents visibility
at lower levels no matter how the document was arrived at
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update to Integrator and Documenting Indexes
Update to remove includes and add TOC to all sub docs
Mass edit of all docs to set [source] tags before source sections
A lot of legacy docs did not use them and code was not displaying
in highlight
Fix missing :ignore-front-matter: tag to 2 documents which were not being
rendered at all
Change source highlighter to more muted yellow/green shade
Adjust the [NOTE] bar colours (improved but not there yet)
Remove some references to distro CD etc from legacy LCNC docs
Signed-off-by: Mick <arceye@mgware.co.uk>
* Modify style sheet to achieve proper contrast between text and background.
Existing style rendered backgrounds in muddy grey with black test,
which made for difficult reading.
Tables and Warnings were particularly bad
All graphic text backgrounds changed to a high contrast pale violet.
[NOTE] colours changed to a more restful pale blue
[WARNING] upgraded to the same type of banner as [NOTE] with muted red
background
To see all above plus [source] highlighting, see
preview.machinekit.io/docs/config/ini_config
which contains the lot.
Goes a long way to fix machinekit#144
Signed-off-by: Mick <arceye@mgware.co.uk>
* Fix visibility of some [NOTE] banners
A peculiar issue with this method of asciidoc to html conversion
in respect of [NOTE]
If the admonition block favoured by asciidoctor is used
[NOTE]
====
Text in here
====
It will be rendered in a white foreground, which is very difficult to read.
If however it is written as per asciidoc, which the legacy docs are
[NOTE]
Text here
The text is rendered in a black foreground and easily legible
A third method used in some legacy docs fails to render properly
with everything after a line break omitted and
back in the page text again
[NOTE]
//__=================================
Big block of text
Another block of text
//__================================
Various docs edited to make NOTE banners easily legible and ensure
the text intended to be displayed in them is so displayed (unless as in
one case there was so much of it, it was a page section not a note)
Signed-off-by: Mick <arceye@mgware.co.uk>
* Fully document Axis GUI enhancements
Add specific doc covering enhancements made to Axis in Machinekit
and add links in existing Axis docs
Signed-off-by: Mick <arceye@mgware.co.uk>
* Updated imagesdir to reflect path of images folder
* Fixed image paths in halui_examples
* Fixed images pahts in pyvpc_examples
* some repair on gladevcp.asciidoc
man is this edited to death
* gcode.asciidoc: this commented FIXME section breaks the page
* basic_hal.asciidoc: now correctly documents 64 bit floats
* diagram-examples.asciidoc: add PlantUML examples
* Makefile: support different output formats
example use:
make docs DOCFORMAT=markdown DOCEXT=md DOC_TARGET=tmp/foo.md
make docs DOCFORMAT=asciidoc DOCEXT=asciidoc DOC_TARGET=tmp/foo.asciidoc
this will use scripts/markdown.mustache and scripts/asciidoc.mustache
respectively
* scripts/asciidoc.mustache: a start - this is still markdown
needs to be rewritten for asciidoc
* add Python examples and install README
* Update README.md
* add support for livereload if Jekyll environment=development
use this gist for trying it: https://gist.github.com/mhaberler/ede68eae275c38a5364734c065a1b9c0
the serve.sh script has no place here - remove
* fix plugins.asciidoc
* deprecate old search links
* Update asciidoc.mustache
Produce asciidoc which is compatible for producing docs with asciidocor used in the website generation
Added file descriptions capability.
* Update APT-packages-jessie.asciidoc
After several re-installations from scratch today I never needed the instructions for libczmq, neither did I need to install it. It might have come for free when installing machinekit, but not sure.
There may be a need to install libczmq/-dev under certain circumstances - I don't know, but for a beginner that just want to run machinekit this installation is not needed.
* Squashed 'machinetalk-protobuf/' content from commit 05de663
git-subtree-dir: machinetalk-protobuf
git-subtree-split: 05de663
* Makefile: make template path configurable, depend on all moving parts
* scripts/gen-proto-docs.sh: pass along template path
* scripts/machinekit-docs.mustache: keep template in mk-docs repo
this simpler to manage than subtree updates
* _config.yml: ignore machinetalk-protobuf subtree
* Makefile: generate protobuf.asciidoc from template and subtree
* Squashed 'machinetalk-protobuf/' changes from 05de663..314b080
314b080 Merge pull request machinekit#62 from mhaberler/master
017ce0a Makefile: make template path configurable, depend on all moving parts
git-subtree-dir: machinetalk-protobuf
git-subtree-split: 314b080
* protobuf.asciidoc: generate target path
* scripts/gen-proto-docs.sh: pass along template path
* scripts/machinekit-docs.mustache: keep template in mk-docs repo
this simpler to manage than subtree updates
* _config.yml: ignore machinetalk-protobuf subtree
* Makefile: generate protobuf.asciidoc from template and subtree
* protobuf.asciidoc: generate target path
* tickle build
* diagram-examples: move highlighting to separate page, adapt links
* tickle build
when two repos are used, the PR builder becomes schizo and doesnt know with SHA to build - trying to figure
* diagrams: make wavedrom use svg instead of png, link to article
* Add QtQuickVcp documentation to site docs
Add link in sidebar and developing indicies
Adapted from repo readme.md
Doubtless capable of polishing:)
Signed-off-by: Mick <arceye@mgware.co.uk>
* Shorten First level title
This is used as title of link in right hand bar entry and needs to be briefer
Signed-off-by: Mick <arceye@mgware.co.uk>
* python-interface: touch up
* kick website-production jenkins job
maybe this does the trick
* Move Search-Bar to primary navigation items for all pages
(top of page)
Remove side bar and front page implementations
Signed-off-by: Mick <arceye@mgware.co.uk>
* hal_pru_generic: import man page from Charles' repo
wget https://raw.githubusercontent.com/cdsteinkuehler/linuxcnc/18ee2e8445d1ef73a17f62d79af465ee4f020fb8/man/man9/hal_pru_generic.9.asciidoc
* hal_pru_generic: cosmetic touchups
* infra: a first stab at repos & flows descriptions
* Capitalise and shorten top level header title
Used as menu link in docs sidebar and needed to be shorter
* fix typo in Makefile
* Amend docs_contents to exclude from google searches
Now that searches are fully seeded, there are a lot of hits coming
from crawlers finding 'boiler plate' sidebar links and including
those
eg. Search `HAL` and the `Hal Utilities and GUIs` link keeps appearing.
First stage is to wrapper in a 'nocontent' div
Once in place I can change the cse.xml to activate it and eventually
the crawlers will exclude it on new crawls.
Signed-off-by: Mick <arceye@mgware.co.uk>
* Delete edittest-adxl345.asciidoc
* diagram-examples: add Google Charts example
* infra: clarify which repos are involved
* index-documenting: fix title
* repositiories: fix typos, expand on mksocfpga, jenkins
* fix typo
* Move `Edit This Page` and `Sandbox` links to navigation area
onto same line as `Search`
The increase in RH sidebar items has pushed these items further down
the page
Moving them makes the layout more coherent, sidebar is for quick access
links to major topics
The navigation list keeps 'Edit this page' in particular, immediately
available and obvious from any page in the site
Signed-off-by: Mick <arceye@mgware.co.uk>
* Update gcode.asciidoc
Added links to example files
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
./configureneeds explicit options as otherwise Xenomai kernel modules are also built.Like:
That is at least confusing.
Tested on wheezy: