Re: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop.
Hi Frank, That’s not possible with the instructions/scripts provided. There may be some black magic that could be done but I am really not familiar enough to provide it. In general though, the docs rendering is not a heavyweight activity and it should not take more than a few seconds to run the project rather than just one document. / Chris From: <opnfv-tech-discuss-boun...@lists.opnfv.org> on behalf of "Frank Brockners (fbrockne)" <fbroc...@cisco.com> Date: Wednesday 10 August 2016 at 13:28 To: Christopher Price <christopher.pr...@ericsson.com>, TECH-DISCUSS OPNFV <opnfv-tech-discuss@lists.opnfv.org> Subject: Re: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop. Hi Chris, thanks for the pointer. Is there a way to just check whether a single file builds/parses correctly – rather than always building the entire project? Thanks, Frank From: opnfv-tech-discuss-boun...@lists.opnfv.org [mailto:opnfv-tech-discuss-boun...@lists.opnfv.org] On Behalf Of Christopher Price Sent: Mittwoch, 10. August 2016 12:29 To: TECH-DISCUSS OPNFV <opnfv-tech-discuss@lists.opnfv.org> Subject: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop. Hi Community, While our CI system provides a complete docs renderer that gives you up to date links to your documentation when you push a patch for review it may be useful for you to work with the toolchain locally while doing you Colorado documentation. This has been made rather simple by our champion of docs scripting Ryota and the procedure is kept up to date and relevant at this link: http://artifacts.opnfv.org/opnfvdocs/docs/how-to-use-docs/documentation-example.html#testing If you would like to render your docs as you go, please try the toolchain above. If you prefer you can also simply push a docs patch and follow the links provided on the review page. Regards, Chris ___ opnfv-tech-discuss mailing list opnfv-tech-discuss@lists.opnfv.org https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss ___ opnfv-tech-discuss mailing list opnfv-tech-discuss@lists.opnfv.org https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
Re: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop.
Just to clarify: I’d like to use the OPNFV tool chain on a set of specific files only and see whether they render correctly – as opposed to just use rst2html (which is what I currently do). Thanks, Frank From: opnfv-tech-discuss-boun...@lists.opnfv.org [mailto:opnfv-tech-discuss-boun...@lists.opnfv.org] On Behalf Of Frank Brockners (fbrockne) Sent: Mittwoch, 10. August 2016 13:28 To: Christopher Price <christopher.pr...@ericsson.com>; TECH-DISCUSS OPNFV <opnfv-tech-discuss@lists.opnfv.org> Subject: Re: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop. Hi Chris, thanks for the pointer. Is there a way to just check whether a single file builds/parses correctly – rather than always building the entire project? Thanks, Frank From: opnfv-tech-discuss-boun...@lists.opnfv.org<mailto:opnfv-tech-discuss-boun...@lists.opnfv.org> [mailto:opnfv-tech-discuss-boun...@lists.opnfv.org] On Behalf Of Christopher Price Sent: Mittwoch, 10. August 2016 12:29 To: TECH-DISCUSS OPNFV <opnfv-tech-discuss@lists.opnfv.org<mailto:opnfv-tech-discuss@lists.opnfv.org>> Subject: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop. Hi Community, While our CI system provides a complete docs renderer that gives you up to date links to your documentation when you push a patch for review it may be useful for you to work with the toolchain locally while doing you Colorado documentation. This has been made rather simple by our champion of docs scripting Ryota and the procedure is kept up to date and relevant at this link: http://artifacts.opnfv.org/opnfvdocs/docs/how-to-use-docs/documentation-example.html#testing If you would like to render your docs as you go, please try the toolchain above. If you prefer you can also simply push a docs patch and follow the links provided on the review page. Regards, Chris ___ opnfv-tech-discuss mailing list opnfv-tech-discuss@lists.opnfv.org https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
Re: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop.
Hi Chris, thanks for the pointer. Is there a way to just check whether a single file builds/parses correctly – rather than always building the entire project? Thanks, Frank From: opnfv-tech-discuss-boun...@lists.opnfv.org [mailto:opnfv-tech-discuss-boun...@lists.opnfv.org] On Behalf Of Christopher Price Sent: Mittwoch, 10. August 2016 12:29 To: TECH-DISCUSS OPNFV <opnfv-tech-discuss@lists.opnfv.org> Subject: [opnfv-tech-discuss] Working with the docs toolchain locally on your laptop. Hi Community, While our CI system provides a complete docs renderer that gives you up to date links to your documentation when you push a patch for review it may be useful for you to work with the toolchain locally while doing you Colorado documentation. This has been made rather simple by our champion of docs scripting Ryota and the procedure is kept up to date and relevant at this link: http://artifacts.opnfv.org/opnfvdocs/docs/how-to-use-docs/documentation-example.html#testing If you would like to render your docs as you go, please try the toolchain above. If you prefer you can also simply push a docs patch and follow the links provided on the review page. Regards, Chris ___ opnfv-tech-discuss mailing list opnfv-tech-discuss@lists.opnfv.org https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
