custom nodes

.github/workflows/continuous-integration.yml

@@ -0,0 +1,21 @@
+name: Continuous Integration
+
+on: 
+    - pull_request
+
+jobs:
+    docs:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v3
+
+        - name: Setup TeX Live
+          uses: teatimeguest/setup-texlive-action@v3
+          with:
+            package-file:  |
+              ci/texlive/texlive_packages
+        - name: Sphinx Action
+          uses: ammaraskar/sphinx-action@master
+          with:
+            docs-folder: "."

.readthedocs.yml → .readthedocs.yaml

@@ -5,6 +5,12 @@
 # Required
 version: 2
 
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: source/conf.py
@@ -14,6 +20,5 @@ formats: all
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
   install:
     - requirements: requirements.txt

requirements.txt

@@ -1,3 +1,3 @@
-sphinx>=1.9.0
+sphinx>=5.0
 sphinx_rtd_theme
-sphinxcontrib-bibtex<2.0.0
+sphinxcontrib-bibtex

source/capturing/capturing.rst

@@ -4,16 +4,16 @@ Capturing
 If this is the first time you are using photogrammetry software, read the following chapter on how to take good photos for your project.
 
 **Basics**
-------
+----------
 
 - Your scene/object should be well lit. 
 - Avoid shadows, reflections, and transparent objects.
 - Take the photos in diffuse or indirect lighting, such as on an overcast day (outdoor) or using multiple light sources (indoor).
-- Don´t use the flash setting on the camera.
+- Don't use the flash setting on the camera.
 - Do not change the focal length/zoom while shooting. Use a fixed focal length lens if possible.
 - Try to take pictures from all angles.
 - Avoid moving objects in the scene or background.
-- If taking pictures using a rotating rig, make sure to use a plain color background with no distiguishable features.
+- If taking pictures using a rotating rig, make sure to use a plain color background with no distinguishable features.
 - The object of interest should always fill most of the image.
 - Take images with a side overlap of 60% minimum and frontal overlap of 80% minimum.
 - For each shot, move to a new position (or rotate the object).

source/conf.py

@@ -40,6 +40,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel', 'sphinx_rtd_theme', 'sphinxcontrib.bibtex']
+bibtex_bibfiles = ['refs.bib']
 sphinxVersion = sphinx.version_info
 if(sphinxVersion[0] <= 1 and sphinxVersion[1] <= 8) :
 	extensions.append('sphinx.ext.pngmath')

source/feature-documentation/cmd/photogrammetry.rst

@@ -1,5 +1,5 @@
 ``meshroom_batch (formerly meshroom_photogrammetry)``
-===========================
+=====================================================
 
 Launch the full photogrammetry or panorama HDR pipeline.
 

source/feature-documentation/core/nodes.rst

@@ -39,6 +39,13 @@ These allow the progress and performance of the process to be monitored.
 API
 +++
 
+You can create custom nodes in python and make them available in Meshroom using the ``MESHROOM_NODES_PATH`` environment variable. 
+
+In a standard precompiled version of Meshroom, you can also directly add custom nodes in ``lib/meshroom/nodes``. 
+If the nodes are placed in a custom folder there should be a Python module (an ``__init__.py`` file is needed) in the folder for the nodes to be recognized by Meshroom, .
+
+To add a new node, you need to create a Python class that inherits from ``desc.Node`` or ``desc.CommandLineNode``.
+
 Naming
 ######