From fa8dc8ee51b91611f1425b1783217d4524777ec1 Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 17:39:17 +0100 Subject: [PATCH 01/10] [sphinx] use new version of sphinxcontrib.bibtex revert previous commit to patch things, just use the latest version declaring the file containing the references --- requirements.txt | 2 +- source/conf.py | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 7a94f69..5217116 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ sphinx>=1.9.0 sphinx_rtd_theme -sphinxcontrib-bibtex<2.0.0 +sphinxcontrib-bibtexpip3 diff --git a/source/conf.py b/source/conf.py index 9a5b6c8..30cef1c 100644 --- a/source/conf.py +++ b/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') From a3a9ef92e51c189805c4491a4ed457243bb2c86e Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 17:39:38 +0100 Subject: [PATCH 02/10] [capturing] fix typo --- source/capturing/capturing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/capturing/capturing.rst b/source/capturing/capturing.rst index 12f794a..d17db06 100644 --- a/source/capturing/capturing.rst +++ b/source/capturing/capturing.rst @@ -9,11 +9,11 @@ If this is the first time you are using photogrammetry software, read the follow - 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). From f40bf8cf8f3f6e0681b38e64dd67fc5801110687 Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 17:39:58 +0100 Subject: [PATCH 03/10] [node] add explanation to add new custom node --- source/feature-documentation/core/nodes.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/feature-documentation/core/nodes.rst b/source/feature-documentation/core/nodes.rst index c900ecc..6946d30 100644 --- a/source/feature-documentation/core/nodes.rst +++ b/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 ###### From 1214e437854318f05234569f25617e451278fc01 Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 17:48:41 +0100 Subject: [PATCH 04/10] [rtd] switch to new config --- .readthedocs.yml => .readthedocs.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) rename .readthedocs.yml => .readthedocs.yaml (80%) diff --git a/.readthedocs.yml b/.readthedocs.yaml similarity index 80% rename from .readthedocs.yml rename to .readthedocs.yaml index 826904a..8718daa 100644 --- a/.readthedocs.yml +++ b/.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 From 7dc894f15c9b894dfd65e50fe2d7d4f3099aa2e7 Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 17:57:40 +0100 Subject: [PATCH 05/10] [py] i'm stupid --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 5217116..029d0f2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ sphinx>=1.9.0 sphinx_rtd_theme -sphinxcontrib-bibtexpip3 +sphinxcontrib-bibtex From 457ddff9e35834c0be3c51539222c43417ba03c7 Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 18:50:06 +0100 Subject: [PATCH 06/10] [ci] github action --- .github/workflows/continuous-integration.yml | 22 ++++++++++++++++++++ requirements.txt | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/continuous-integration.yml diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml new file mode 100644 index 0000000..b9667f9 --- /dev/null +++ b/.github/workflows/continuous-integration.yml @@ -0,0 +1,22 @@ +name: Continuous Integration + +on: + - pull_request + - push + +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: "." \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 029d0f2..2faeac7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -sphinx>=1.9.0 +sphinx>=5.0 sphinx_rtd_theme sphinxcontrib-bibtex From 8c9e4cb2352d3fe84cdc5275a7442618297a988c Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 19:05:53 +0100 Subject: [PATCH 07/10] [ci] remove travis --- .travis.yml | 60 ----------------------------------------------------- 1 file changed, 60 deletions(-) delete mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index f87de5f..0000000 --- a/.travis.yml +++ /dev/null @@ -1,60 +0,0 @@ -dist: xenial - -language: python - -python: - - 3.5 - -install: - - pip install -r requirements.txt - - source ./ci/texlive/texlive_install.sh - -cache: - directories: - - /tmp/texlive - - $HOME/.texlive - -script: - - cd ${TRAVIS_BUILD_DIR} - - make html - - make latex - - cd build/latex - - LATEXNAME=meshroom - #- pdflatex -interaction nonstopmode -halt-on-error -file-line-error ${LATEXNAME}.tex - - pdflatex -interaction nonstopmode -file-line-error ${LATEXNAME}.tex - - - # in case there are other latex packages to install texliveonfly will do the - # installation of the required packages automatically - # - make latex - # - cd build - # - cd latex - # - texliveonfly meshroom.tex - # or add them to the list in ci/texlive/texlive_packages - -before_deploy: - - BUILD_DIR=${TRAVIS_BUILD_DIR}/build - - ARCHIVE_BASE_PATH=${BUILD_DIR} - - TARGET_VERSION=$(echo ${TRAVIS_TAG} | cut -d "v" -f2) - # deploy the html - - TARGET_NAME=html - - TARGET_FULL_NAME=meshroom_doc-${TARGET_NAME}-${TARGET_VERSION} - - INSTALL_ARCHIVE_FILENAME=${TARGET_FULL_NAME}.tgz - - cd ${BUILD_DIR} - - tar -czvf ${INSTALL_ARCHIVE_FILENAME} ${TARGET_NAME} - # deploy the pdf - - TARGET_NAME=pdf - - TARGET_FULL_NAME=meshroom_doc-${TARGET_VERSION} - - INSTALL_PDF_FILENAME=${TARGET_FULL_NAME}.pdf - - cp latex/${LATEXNAME}.pdf ${INSTALL_PDF_FILENAME} - -deploy: - provider: releases - api_key: - secure: ${GITHUB_RELEASE_API_KEY} - file: - - ${ARCHIVE_BASE_PATH}/${INSTALL_ARCHIVE_FILENAME} - - ${ARCHIVE_BASE_PATH}/${INSTALL_PDF_FILENAME} - skip_cleanup: true - on: - tags: true From 7b129ad03822a78120118adea587655101b877bd Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 21:12:18 +0100 Subject: [PATCH 08/10] [capturing] fix title --- source/capturing/capturing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/capturing/capturing.rst b/source/capturing/capturing.rst index d17db06..b41cc75 100644 --- a/source/capturing/capturing.rst +++ b/source/capturing/capturing.rst @@ -4,7 +4,7 @@ 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. From fe2fac1bc1735bd9236d30ac745110a0cc30de45 Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 21:25:04 +0100 Subject: [PATCH 09/10] [feature] fix title --- source/feature-documentation/cmd/photogrammetry.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/feature-documentation/cmd/photogrammetry.rst b/source/feature-documentation/cmd/photogrammetry.rst index f8ebccd..a57b97f 100644 --- a/source/feature-documentation/cmd/photogrammetry.rst +++ b/source/feature-documentation/cmd/photogrammetry.rst @@ -1,5 +1,5 @@ ``meshroom_batch (formerly meshroom_photogrammetry)`` -=========================== +===================================================== Launch the full photogrammetry or panorama HDR pipeline. From 166ebb5800d32f735a42e69bf3ae251013449dce Mon Sep 17 00:00:00 2001 From: Simone Gasparini Date: Tue, 28 Nov 2023 21:25:47 +0100 Subject: [PATCH 10/10] [ci] only pull requests --- .github/workflows/continuous-integration.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index b9667f9..9b3274c 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -2,7 +2,6 @@ name: Continuous Integration on: - pull_request - - push jobs: docs: