DocFx Plugin and object metadata exporter.
Visual studio solution in this repository contains two project
- ClassicDynamicsNavDocExporter - executable that can generate object metadata for DocFx from Dynamics Nav source code text files
- ClassicDynamicsNavReference - library used by both ClassicDynamicsNavDocExporter and DocFx plugin to process objects metadata
Full DocFx template can be found in ClassicAL-DocFx-Template template, it already contains dll produced by ClassicDynamicsNavReference in docfx_project\defaultcal\plugins folder
If you want to change something in ClassicDynamicsNavReference, make sure that you also copy this dll to your docfx_project\defaultcal\plugins folder
How to use it
- Download empty DocFx project from my ClassicAL-DocFx-Template repository
- Export your Dynamics Nav objects to text file to docfx_project\src folder of project downloaded in step 1
- Run ClassicDynamicsNavDocExporter.exe and specify Dynamics Nav source code text file, output path for object metadata (docfx_project\api) and name of your project (it will be used in generated documentation). Assuming that you extracted docfx_project from step 1 in c:\temp\docfx_project, your project name is MyDynamicsNavProject and your objects are in AllObjects.txt file, you should run this command: ClassicDynamicsNavDocExporter.exe c:\temp\docfx_project\src\AllObjects.txt c:\temp\docfx_project\api MyDynamicsNavProject
- Go to your docfx_project folder and run DocFx to build documentation from the metadata: cd c:\temp\docfx_project docfx
- Your documentation should be generated in docfx_project_site\api folder, go there and open index.html file to check if it looks fine. It might not work for you this way, because this template is based on standard c# DocFx template and uses plenty of JavaScript. I was able to open index.html file directly in Firefox, it does not work this way in opera, chrome and IE for me. It works fine if you publish whole _site folder on IIS.