Gencode to include inline examples from test directory #431
Conversation
This file contains 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
noursaidi
force-pushed
the
include_examples
branch
from
951da7a
to
1a87e97
Compare
|
Do you have an example file where this has been done (.md) file or
something? I tried it out and it's not working, but there's a lot of
places I was guessing... Maybe take it to the next level where it's setup
to work with one example somewhere? (Don't need to worry about the check
part intiaily, just the generation part)
…On Thu, Aug 25, 2022 at 4:35 AM Noureddine ***@***.***> wrote:
Draft PR of some code I've done previously to which does a live in-place
update of documentation with examples from the examples folder for review.
It includes a check function for CI testing, but I just need to have a
think about how it integrates (because gencode check still runs gendocs,
which means the documentation is updated before it's checked
Usage:
Include anywhere in an MD document <!--example:state/example.json-->
where state is the bit preceding the .tests (e.g. event_discovery) and
example.json is the name of the file to include.
Run bin/gencode_docs_examples to update the example, or bin/gencode_docs_examples
check to check if the file includes current examples
Then bin/gencode_doc_examples
------------------------------
You can view, comment on, or merge this pull request online at:
#431
Commit Summary
- 9862acb
<9862acb>
commit gencode_doc_examples
File Changes
(1 file <https://github.com/faucetsdn/udmi/pull/431/files>)
- *A* bin/gencode_doc_examples
<https://github.com/faucetsdn/udmi/pull/431/files#diff-69293c55585af32b1c5f5f99078a09eb7fc17e0b486861876c64e6996987e101>
(143)
Patch Links:
- https://github.com/faucetsdn/udmi/pull/431.patch
- https://github.com/faucetsdn/udmi/pull/431.diff
—
Reply to this email directly, view it on GitHub
<#431>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAIEPDZ3U5I3SDUO7FB44EDV25LBNANCNFSM57SX5FFA>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
|
This PR was closed... is it still live? Seems like it's a good idea still? |
|
It was merged into #447 and then eventually into master |
|
Brilliant, thanks!
…On Tue, Oct 11, 2022 at 8:36 AM Noureddine ***@***.***> wrote:
It was merged into #447 <#447> and
then eventually into master
—
Reply to this email directly, view it on GitHub
<#431 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAIEPDZNE344BLKTCIGOI43WCWCQZANCNFSM57SX5FFA>
.
You are receiving this because your review was requested.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Draft PR of some code I've done previously to which does a live in-place update of documentation with examples from the examples folder for review.
It includes a
checkfunction for CI testing, but I just need to have a think about how it integrates (becausegencode checkstill runsgendocs, which means the documentation is updated before it's checked)Usage:
Include anywhere in an MD document
<!--example:state/example.json-->wherestateis the bit preceding the.tests(e.g. event_discovery) andexample.jsonis the name of the file to include.Run
bin/gencode_docs_examplesto update examples in documentation, orbin/gencode_docs_examples checkto check if the documentation includes latest examples