alexander-hanel / msdocsviewer Goto Github PK

Hi, thanks for the great work!

The slash used in

Btw, it'd be great if you could release a version for apis_md, since I'm not sure what I generated is the full coverage.

When you parse the md's you split on ---:

https://github.com/alexander-hanel/msdocsviewer/blob/main/run_me_first.py#L39

Later you make the assumption that data_split[2] has the rest of the md:

https://github.com/alexander-hanel/msdocsviewer/blob/main/run_me_first.py#L61

But this doesn't work because if the md has flag values then those are represented as a table which uses the following markdown:

| Flag | Meaning |
| ---- | ------- |

So you end up capturing only the rest of the md up to the first instance of any flag values that may exist. You can see an example here:

https://github.com/MicrosoftDocs/windows-driver-docs-ddi/blob/5b57a3e1a8d4948e1286dd616e79455440df7117/wdk-ddi-src/content/ntifs/nf-ntifs-rtlallocateheap.md?plain=1#L64

i have already modified this function
def OnClose(self, form):
"""
Called when the widget is closed
"""
global frm
global started
del frm
started = False
Then，
Failed while executing plugin_t.run():
Traceback (most recent call last):
File "h:/tools/IDA 7.6/IDA Pro 7.6/plugins/msdocviewida.py", line 110, in run
frm.load_markdown()
File "h:/tools/IDA 7.6/IDA Pro 7.6/plugins/msdocviewida.py", line 73, in load_markdown
self.markdown_viewer.setMarkdown(api_markdown)
AttributeError: 'QTextEdit' object has no attribute 'setMarkdown'

didn't you mean to use the github.com/MicrosoftDocs/win… repo for driver docs instead? The one you link is for conceptual, not API documentation.

Source

in readme.md file:
Should be: "cd msdocsviwer", not "cd msdocviwer"

Great plugin, tks you

Use github action to automatically run run_me_first.py to get the documentation.

name: msdocviewer-parser

on:
    push:
      branches: [ "main" ]
    pull_request:
      branches: [ "main" ]
      
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v4
        with:
          submodules: 'recursive'
      
      - name: 设置python版本
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'
      
      - name: 安装依赖
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: 运行脚本
        run: |
          python run_me_first.py --overwrite
      
      - name: 压缩文件夹
        run: zip -r apis_md.zip ./apis_md
      
      - name: upload-artifact
        uses: actions/[email protected]
        with:
            name: apis_md.zip
            path: ./apis_md.zip
          
      - name: 发布
        uses: "marvinpinto/action-automatic-releases@latest"
        with:
          repo_token: "${{ secrets.GITHUB_TOKEN }}"
          automatic_release_tag: "latest"
          prerelease: false
          title: "Auto Build"
          files: ./apis_md.zip

Add pyqt autocomplete option - https://pythonbasics.org/pyqt-auto-complete/