Update check file structure script for docs #117636

Closed
opened 2024-01-29 16:08:34 +01:00 by Brecht Van Lommel · 6 comments

After the move to developer.blender.org/docs, the tools/check_wiki/check_wiki_file_structure.py script no longer works.

This script should be renamed and updated.

After the move to developer.blender.org/docs, the `tools/check_wiki/check_wiki_file_structure.py` script no longer works. This script should be renamed and updated.
Brecht Van Lommel added the
Meta
Good First Issue
Type
To Do
labels 2024-01-29 16:08:35 +01:00
Brecht Van Lommel added this to the Developer Documentation project 2024-01-29 16:08:37 +01:00
Contributor

I get HTTP 403: Forbidden error after running the check_wiki_file.py. Which URL should I use in WIKI_URL_EDIT

I get HTTP 403: Forbidden error after running the check_wiki_file.py. Which URL should I use in WIKI_URL_EDIT
Author
Owner

The variable name WIKI_URL_EDIT doesn't make sense anymore now. It's not a matter or replacing its value but changing the logic of how to get the page source. Which can be found here:
https://projects.blender.org/blender/blender-developer-docs/raw/branch/main/docs/features/code_layout.md

The variable name `WIKI_URL_EDIT` doesn't make sense anymore now. It's not a matter or replacing its value but changing the logic of how to get the page source. Which can be found here: https://projects.blender.org/blender/blender-developer-docs/raw/branch/main/docs/features/code_layout.md
Contributor

And also wanted to know how would the wiki_file_structure.txt generated after running the py file look like. Would it contain the whole Source code of: https://projects.blender.org/blender/blender-developer-docs/raw/branch/main/docs/features/code_layout.md
As it works now looks something like this

And also wanted to know how would the wiki_file_structure.txt generated after running the py file look like. Would it contain the whole Source code of: https://projects.blender.org/blender/blender-developer-docs/raw/branch/main/docs/features/code_layout.md As it works now looks something like this
Author
Owner

I think it would output the whole modified source code, yes. Maybe make an -o / --output argument to specify the file to write to.

I think it would output the whole modified source code, yes. Maybe make an `-o` / `--output` argument to specify the file to write to.
Contributor

Also could you suggest me the name to rename the file and all the places where Wiki is mentioned

Also could you suggest me the name to rename the file and all the places where Wiki is mentioned
Author
Owner

The script could be called check_docs/check_docs_code_layout.py.

The word "wiki" I guess would be mostly replaced by "markdown".

The script could be called `check_docs/check_docs_code_layout.py`. The word "wiki" I guess would be mostly replaced by "markdown".
Blender Bot added the
Status
Resolved
label 2024-02-02 18:59:23 +01:00
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#117636
No description provided.