FreeCAD Nodes (renamed from fc_nodes)

Show off your FreeCAD projects here!
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
User avatar
ebrahim raeyat
Posts: 619
Joined: Sun Sep 09, 2018 7:00 pm
Location: Iran
Contact:

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by ebrahim raeyat »

j8sr0230 wrote: Wed Dec 14, 2022 11:54 am
I am currently researching possible documentation frameworks that will allow me to maintain high quality documentation with reasonable effort (although the nodes will probably still change here and there). I ask for some patience, but shouldn't take too much longer ;)
I don't know if it is useful for you or not, but mkdocs is an alternative, you can create github page also with it:

https://realpython.com/python-project-d ... th-mkdocs/
User avatar
flachyjoe
Veteran
Posts: 1869
Joined: Sat Mar 31, 2012 12:00 pm
Location: Limoges, France

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by flachyjoe »

drmacro wrote: Wed Dec 14, 2022 7:41 pm Am I misunderstanding your comment?
My comment only contains what I wrote, without a second thought ;)
drmacro wrote: Wed Dec 14, 2022 7:41 pm use the tool...not learn to program.
Be aware of the mirage of ease of use. As I said graphical scripting require as skill as programming.
drmacro wrote: Wed Dec 14, 2022 7:41 pm I didn't need to learn the Blender API
I totally agree, as in python macro you don't take care about OCCT.
BUT with such a high level language as Node tends to be you certainly lack for a node one day and happy to know how to make yours.
SO I think Nodes documentation needs two level reading with basic usage plus power-user explanation. FreeCAD wiki exposes such two-level information with 'click' and 'macro' usage.
- Flachy Joe -
Image
User avatar
j8sr0230
Posts: 140
Joined: Thu Apr 07, 2022 8:59 am
Location: Chemnitz
Contact:

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by j8sr0230 »

I've dabbled a bit with the ReadTheDocs framework and it's shockingly easy to set up documentation based on a GitHub project (see https://freecad-nodes.readthedocs.io/en ... index.html). Another advantage is that Sverchok also hosts its documentation on ReadTheDocs and generates it with Sphinx, which thus provides an excellent template for FreeCAD Nodes documentation (user and developer or API documentation). Can the FreeCAD Wiki also host *.rst documentation files from my Git repository? Otherwise I would prefer a generated Sphinx documentation on ReadTheDocs. They can be translated in the same way.
Codelink on GitHub: https://github.com/j8sr0230/codelink
Codelink on PiPy: https://pypi.org/project/codelink/
FreeCAD Nodes Workbench on GitHub: https://github.com/j8sr0230/Nodes
User avatar
j8sr0230
Posts: 140
Joined: Thu Apr 07, 2022 8:59 am
Location: Chemnitz
Contact:

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by j8sr0230 »

The description of the FreeCAD-documentation repository (https://github.com/FreeCAD/FreeCAD-documentation) says the following: [...]
Please no pull requests for the time being, edit the wiki instead, thanks! [...] This information leads me to conclude that currently FreeCAD Wiki entries must be edited manually in the wiki interface and no *.rst files from my repo can be hosted there. I find this a pity for two reasons: First, the complete documentation including API has to be typed manually and second, code and documentation are not in one repository. Nevertheless, since I highly appreciate and would like to enrich the FreeCAD Wiki as a source of information, I would like to present the following documentation workflow for discussion:
  • Code documentation according to PEP8 with DocString and comments
  • FreeCAD Nodes user and API documentation with Sphinx from my repo, hosted on ReadTheDocs (https://freecad-nodes.readthedocs.io/en ... index.html)
  • Regular conversion of the docs from *.rst to *.md using Pandoc and manual pasting into the FreeCAD Wiki
What is your opinion?
Codelink on GitHub: https://github.com/j8sr0230/codelink
Codelink on PiPy: https://pypi.org/project/codelink/
FreeCAD Nodes Workbench on GitHub: https://github.com/j8sr0230/Nodes
User avatar
flachyjoe
Veteran
Posts: 1869
Joined: Sat Mar 31, 2012 12:00 pm
Location: Limoges, France

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by flachyjoe »

@j8sr0230 the FreeCAD-documentation repository is wiki to markdown auto-generated. Conversion is not done in the other direction.

You may ask for help in the wiki forum https://forum.freecadweb.org/viewforum.php?f=21
- Flachy Joe -
Image
User avatar
j8sr0230
Posts: 140
Joined: Thu Apr 07, 2022 8:59 am
Location: Chemnitz
Contact:

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by j8sr0230 »

flachyjoe wrote: Thu Dec 15, 2022 12:03 pm @j8sr0230 the FreeCAD-documentation repository is wiki to markdown auto-generated. Conversion is not done in the other direction.

You may ask for help in the wiki forum https://forum.freecadweb.org/viewforum.php?f=21
But I can create markdown using Pandoc and paste it to the FreeCAD Nodes Wiki page or am I wrong?
Codelink on GitHub: https://github.com/j8sr0230/codelink
Codelink on PiPy: https://pypi.org/project/codelink/
FreeCAD Nodes Workbench on GitHub: https://github.com/j8sr0230/Nodes
User avatar
flachyjoe
Veteran
Posts: 1869
Joined: Sat Mar 31, 2012 12:00 pm
Location: Limoges, France

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by flachyjoe »

j8sr0230 wrote: Thu Dec 15, 2022 12:09 pm But I can create markdown using Pandoc and paste it to the FreeCAD Nodes Wiki page or am I wrong?
I don't know :?
- Flachy Joe -
Image
User avatar
j8sr0230
Posts: 140
Joined: Thu Apr 07, 2022 8:59 am
Location: Chemnitz
Contact:

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by j8sr0230 »

ebrahim raeyat wrote: Wed Dec 14, 2022 9:48 pm
j8sr0230 wrote: Wed Dec 14, 2022 11:54 am
I am currently researching possible documentation frameworks that will allow me to maintain high quality documentation with reasonable effort (although the nodes will probably still change here and there). I ask for some patience, but shouldn't take too much longer ;)
I don't know if it is useful for you or not, but mkdocs is an alternative, you can create github page also with it:

https://realpython.com/python-project-d ... th-mkdocs/
Valuable information, I will check it out! Thanks ...
Codelink on GitHub: https://github.com/j8sr0230/codelink
Codelink on PiPy: https://pypi.org/project/codelink/
FreeCAD Nodes Workbench on GitHub: https://github.com/j8sr0230/Nodes
User avatar
j8sr0230
Posts: 140
Joined: Thu Apr 07, 2022 8:59 am
Location: Chemnitz
Contact:

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by j8sr0230 »

For your information
I'm currently working on a major revision of the node editor, which should improve the node layout in particular. Likewise, I'd like to cleanly implement the input widgets that were originally planned but then discarded. When I'm happy with the layout, vidos and tutorials will come. It goes on and on :)
Greetings j8sr0230 :D
Codelink on GitHub: https://github.com/j8sr0230/codelink
Codelink on PiPy: https://pypi.org/project/codelink/
FreeCAD Nodes Workbench on GitHub: https://github.com/j8sr0230/Nodes
bleber
Posts: 259
Joined: Thu Jun 30, 2016 5:12 pm

Re: FreeCAD Nodes (renamed from fc_nodes)

Post by bleber »

Ok, I am expected to play with these.
Go on with your work.
Post Reply