Skip to content

deployment - build passed but autogenerate index file instead of using my markdown index. #9165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
aaa34169 opened this issue May 4, 2022 · 3 comments
Closed

deployment - build passed but autogenerate index file instead of using my markdown index. #9165

aaa34169 opened this issue May 4, 2022 · 3 comments
Labels
Needed: more information A reply from issue author is required Support Support question

Comments

@aaa34169
Copy link

aaa34169 commented May 4, 2022

Hello

i am intended to generate the documentation of my project. Instead of to use rst, i use markdown as default source suffix
I came across a perfect video tutorial, really educative.
I followed each steps. Locally, my documentation is correctly generated.

When, i deployed it on readthedoc, build passed ( there are no warnings) but instead of to consider my index.md, the deployed documentation renders the autogenerated index ! I don t know why

Help is welcome

Details

my [project] (https://github.com/pyCGM2/pyCGM2)

There is a docs folder with sphinx source and requirements that i called from the readthedocs.yaml

So far, i haven t called autodoc function. that will be my next steps

Expected Result

deployed documentation considering my markdown files

Actual Result

autogenerated index file !!

Here is below the latest build log

all sound work fine.

Read the Docs build information
Build id: 16818750
Project: pycgm2
Version: latest
Commit: 9a277a95a78436eb96f213af5befda7f3a9fec91
Date: 2022-05-04T08:07:18.138387Z
State: finished
Success: True


[rtd-command-info] start-time: 2022-05-04T08:07:28.179255Z, end-time: 2022-05-04T08:07:38.042894Z, duration: 9, exit-code: 0
git clone --no-single-branch --depth 50 https://github.com/pyCGM2/pyCGM2.git .
Cloning into '.'...
Updating files:  91% (353/385)
Updating files:  92% (355/385)
Updating files:  93% (359/385)
Updating files:  94% (362/385)
Updating files:  95% (366/385)
Updating files:  96% (370/385)
Updating files:  97% (374/385)
Updating files:  98% (378/385)
Updating files:  99% (382/385)
Updating files: 100% (385/385)
Updating files: 100% (385/385), done.

[rtd-command-info] start-time: 2022-05-04T08:07:38.252172Z, end-time: 2022-05-04T08:07:38.404178Z, duration: 0, exit-code: 0
git checkout --force origin/Master
Note: switching to 'origin/Master'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 9a277a9 only md

[rtd-command-info] start-time: 2022-05-04T08:07:38.694155Z, end-time: 2022-05-04T08:07:38.766382Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2022-05-04T08:07:47.819168Z, end-time: 2022-05-04T08:07:48.232960Z, duration: 0, exit-code: 0
asdf global python 3.7.12


[rtd-command-info] start-time: 2022-05-04T08:07:49.111728Z, end-time: 2022-05-04T08:07:50.282689Z, duration: 1, exit-code: 0
python -mvirtualenv /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest
created virtual environment CPython3.7.12.final.0-64 in 732ms
  creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest, clear=False, no_vcs_ignore=False, global=False)
  seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv)
    added seed packages: pip==21.2.3, setuptools==57.4.0, wheel==0.37.0
  activators BashActivator,CShellActivator,FishActivator,PowerShellActivator,PythonActivator

[rtd-command-info] start-time: 2022-05-04T08:07:50.526961Z, end-time: 2022-05-04T08:07:59.963927Z, duration: 9, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/bin/python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0
Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (21.2.3)
Collecting pip
  Downloading pip-22.0.4-py3-none-any.whl (2.1 MB)
Requirement already satisfied: setuptools<58.3.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (57.4.0)
Collecting setuptools<58.3.0
  Downloading setuptools-58.2.0-py3-none-any.whl (946 kB)
Installing collected packages: setuptools, pip
  Attempting uninstall: setuptools
    Found existing installation: setuptools 57.4.0
    Uninstalling setuptools-57.4.0:
      Successfully uninstalled setuptools-57.4.0
  Attempting uninstall: pip
    Found existing installation: pip 21.2.3
    Uninstalling pip-21.2.3:
      Successfully uninstalled pip-21.2.3
Successfully installed pip-22.0.4 setuptools-58.2.0

[rtd-command-info] start-time: 2022-05-04T08:08:00.238910Z, end-time: 2022-05-04T08:08:09.900722Z, duration: 9, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/bin/python -m pip install --upgrade --no-cache-dir mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.2
Collecting mock==1.0.1
  Downloading mock-1.0.1.zip (861 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 KB 18.7 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting pillow==5.4.1
  Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 101.7 MB/s eta 0:00:00
Collecting alabaster!=0.7.5,<0.8,>=0.7
  Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB)
Collecting commonmark==0.8.1
  Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 47.4/47.4 KB 166.3 MB/s eta 0:00:00
Collecting recommonmark==0.5.0
  Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB)
Collecting sphinx
  Downloading Sphinx-4.5.0-py3-none-any.whl (3.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 125.0 MB/s eta 0:00:00
Collecting sphinx-rtd-theme
  Downloading sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl (2.8 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 142.8 MB/s eta 0:00:00
Collecting readthedocs-sphinx-ext<2.2
  Downloading readthedocs_sphinx_ext-2.1.5-py2.py3-none-any.whl (11 kB)
Collecting future
  Downloading future-0.18.2.tar.gz (829 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 829.2/829.2 KB 225.8 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting docutils>=0.11
  Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.0/570.0 KB 214.7 MB/s eta 0:00:00
Collecting sphinxcontrib-jsmath
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Collecting imagesize
  Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB)
Collecting docutils>=0.11
  Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 KB 221.5 MB/s eta 0:00:00
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 KB 192.5 MB/s eta 0:00:00
Collecting sphinxcontrib-devhelp
  Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 KB 190.0 MB/s eta 0:00:00
Collecting babel>=1.3
  Downloading Babel-2.10.1-py3-none-any.whl (9.5 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.5/9.5 MB 142.5 MB/s eta 0:00:00
Collecting importlib-metadata>=4.4
  Downloading importlib_metadata-4.11.3-py3-none-any.whl (18 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.0
  Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 KB 176.1 MB/s eta 0:00:00
Collecting sphinxcontrib-serializinghtml>=1.1.5
  Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 KB 197.9 MB/s eta 0:00:00
Collecting Pygments>=2.0
  Downloading Pygments-2.12.0-py3-none-any.whl (1.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 222.9 MB/s eta 0:00:00
Collecting Jinja2>=2.3
  Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 KB 201.5 MB/s eta 0:00:00
Collecting packaging
  Downloading packaging-21.3-py3-none-any.whl (40 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 KB 167.0 MB/s eta 0:00:00
Collecting requests>=2.5.0
  Downloading requests-2.27.1-py2.py3-none-any.whl (63 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 63.1/63.1 KB 174.4 MB/s eta 0:00:00
Collecting sphinxcontrib-applehelp
  Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 KB 185.7 MB/s eta 0:00:00
Collecting sphinxcontrib-qthelp
  Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 KB 157.0 MB/s eta 0:00:00
Collecting pytz>=2015.7
  Downloading pytz-2022.1-py2.py3-none-any.whl (503 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 503.5/503.5 KB 212.7 MB/s eta 0:00:00
Collecting zipp>=0.5
  Downloading zipp-3.8.0-py3-none-any.whl (5.4 kB)
Collecting typing-extensions>=3.6.4
  Downloading typing_extensions-4.2.0-py3-none-any.whl (24 kB)
Collecting MarkupSafe>=2.0
  Downloading MarkupSafe-2.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB)
Collecting charset-normalizer~=2.0.0
  Downloading charset_normalizer-2.0.12-py3-none-any.whl (39 kB)
Collecting idna<4,>=2.5
  Downloading idna-3.3-py3-none-any.whl (61 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.2/61.2 KB 191.6 MB/s eta 0:00:00
Collecting certifi>=2017.4.17
  Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 149.2/149.2 KB 206.6 MB/s eta 0:00:00
Collecting urllib3<1.27,>=1.21.1
  Downloading urllib3-1.26.9-py2.py3-none-any.whl (138 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 139.0/139.0 KB 206.2 MB/s eta 0:00:00
Collecting pyparsing!=3.0.5,>=2.0.2
  Downloading pyparsing-3.0.8-py3-none-any.whl (98 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.5/98.5 KB 192.2 MB/s eta 0:00:00
Building wheels for collected packages: mock, future
  Building wheel for mock (setup.py): started
  Building wheel for mock (setup.py): finished with status 'done'
  Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23772 sha256=3f5621f76a566b62e2d0783204fa7a3ebbb3459b119fc987bda6dd6441dfa101
  Stored in directory: /tmp/pip-ephem-wheel-cache-fxe1etj2/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1
  Building wheel for future (setup.py): started
  Building wheel for future (setup.py): finished with status 'done'
  Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491070 sha256=b70c5a45efd50f277fba8fdd5d09d373fa8bdd7ffb4a62f2266cecbf68da9060
  Stored in directory: /tmp/pip-ephem-wheel-cache-fxe1etj2/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0
Successfully built mock future
Installing collected packages: snowballstemmer, pytz, mock, certifi, alabaster, zipp, urllib3, typing-extensions, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, pyparsing, Pygments, pillow, MarkupSafe, imagesize, idna, future, docutils, charset-normalizer, babel, requests, packaging, Jinja2, importlib-metadata, commonmark, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark
Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.1 Pygments-2.12.0 alabaster-0.7.12 babel-2.10.1 certifi-2021.10.8 charset-normalizer-2.0.12 commonmark-0.8.1 docutils-0.17.1 future-0.18.2 idna-3.3 imagesize-1.3.0 importlib-metadata-4.11.3 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.8 pytz-2022.1 readthedocs-sphinx-ext-2.1.5 recommonmark-0.5.0 requests-2.27.1 snowballstemmer-2.2.0 sphinx-4.5.0 sphinx-rtd-theme-1.0.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 typing-extensions-4.2.0 urllib3-1.26.9 zipp-3.8.0

[rtd-command-info] start-time: 2022-05-04T08:08:10.259109Z, end-time: 2022-05-04T08:08:12.241205Z, duration: 1, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
Requirement already satisfied: sphinx==4.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from -r docs/requirements.txt (line 1)) (4.5.0)
Collecting myst-parser==0.17.2
  Downloading myst_parser-0.17.2-py3-none-any.whl (53 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.8/53.8 KB 4.4 MB/s eta 0:00:00
Requirement already satisfied: sphinx-rtd-theme==1.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from -r docs/requirements.txt (line 3)) (1.0.0)
Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (1.0.2)
Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2.2.0)
Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (1.0.2)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (1.1.5)
Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2.10.1)
Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (0.7.12)
Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2.27.1)
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (21.3)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (3.1.2)
Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (1.3.0)
Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (1.0.1)
Requirement already satisfied: docutils<0.18,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (0.17.1)
Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2.12.0)
Requirement already satisfied: importlib-metadata>=4.4 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (4.11.3)
Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from sphinx==4.5.0->-r docs/requirements.txt (line 1)) (1.0.3)
Collecting markdown-it-py<3.0.0,>=1.0.0
  Downloading markdown_it_py-2.1.0-py3-none-any.whl (84 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.5/84.5 KB 7.9 MB/s eta 0:00:00
Requirement already satisfied: typing-extensions in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from myst-parser==0.17.2->-r docs/requirements.txt (line 2)) (4.2.0)
Collecting mdit-py-plugins~=0.3.0
  Downloading mdit_py_plugins-0.3.0-py3-none-any.whl (43 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 43.7/43.7 KB 158.6 MB/s eta 0:00:00
Collecting pyyaml
  Downloading PyYAML-6.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (596 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 596.3/596.3 KB 26.4 MB/s eta 0:00:00
Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from babel>=1.3->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2022.1)
Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from importlib-metadata>=4.4->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (3.8.0)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2.1.1)
Collecting mdurl~=0.1
  Downloading mdurl-0.1.1-py3-none-any.whl (10 kB)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2021.10.8)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (1.26.9)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (3.3)
Requirement already satisfied: charset-normalizer~=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (2.0.12)
Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/lib/python3.7/site-packages (from packaging->sphinx==4.5.0->-r docs/requirements.txt (line 1)) (3.0.8)
Installing collected packages: pyyaml, mdurl, markdown-it-py, mdit-py-plugins, myst-parser
Successfully installed markdown-it-py-2.1.0 mdit-py-plugins-0.3.0 mdurl-0.1.1 myst-parser-0.17.2 pyyaml-6.0

[rtd-command-info] start-time: 2022-05-04T08:08:14.443327Z, end-time: 2022-05-04T08:08:14.495881Z, duration: 0, exit-code: 0
cat docs/source/conf.py
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'pyCGM2-API'
copyright = '2022, Fabien Leboeuf'
author = 'Fabien Leboeuf'

# The full version, including alpha/beta/rc tags
release = '4.2.0'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["myst_parser",
             "sphinx.ext.autosectionlabel",
             'sphinx.ext.napoleon',
             "sphinx.ext.autodoc" ]

source_suffix = ['.md']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#
# Note: this file shouldn't rely on extra dependencies.

import importlib
import sys
import os.path

# Borrowed from six.
PY3 = sys.version_info[0] == 3
string_types = str if PY3 else basestring

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
    (
        'html_theme' in globals() and
        html_theme in ['default'] and
        # Allow people to bail with a hack of having an html_style
        'html_style' not in globals()
    ) or 'html_theme' not in globals()
)
if using_rtd_theme:
    theme = importlib.import_module('sphinx_rtd_theme')
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.org/websupport'
    websupport2_static_url = 'https://assets.readthedocs.org/static/'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.org/",
    'STATIC_URL': "https://assets.readthedocs.org/static/",
    'PRODUCTION_DOMAIN': "readthedocs.org",
    'versions': [
    ("latest", "/en/latest/"),
    ("stable", "/en/stable/"),
    ],
    'downloads': [ 
    ],
    'subprojects': [ 
    ],
    'slug': 'pycgm2',
    'name': u'pyCGM2',
    'rtd_language': u'en',
    'programming_language': u'words',
    'canonical_url': 'https://pycgm2.readthedocs.io/en/latest/',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/docs/source/',
    'api_host': 'https://readthedocs.org',
    'github_user': 'pyCGM2',
    'proxied_api_host': '/_',
    'github_repo': 'pyCGM2',
    'github_version': 'Master',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'Master',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'Master',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-1',
    'commit': '9a277a95',
}

# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
if version_info >= (1, 8):
    if not globals().get('html_baseurl'):
        html_baseurl = context['canonical_url']
    context['canonical_url'] = None





if 'html_context' in globals():
    
    html_context.update(context)
    
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    # Insert at the beginning because it can interfere
    # with other extensions.
    # See https://github.com/rtfd/readthedocs.org/pull/4054
    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]

# Add External version warning banner to the external version documentation
if 'branch' == 'external':
    extensions.insert(1, "readthedocs_ext.external_version_warning")
    readthedocs_vcs_url = 'None'
    readthedocs_build_url = 'https://readthedocs.org/projects/pycgm2/builds/16818750/'

project_language = 'en'

# User's Sphinx configurations
language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)

# Remove this once xindy gets installed in Docker image and XINDYOPS
# env variable is supported
# https://github.com/rtfd/readthedocs-docker-images/pull/98
latex_use_xindy = False

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanese = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanese:
    latex_engine = latex_engine_user or 'platex'

# Make sure our build directory is always excluded
exclude_patterns = globals().get('exclude_patterns', [])
exclude_patterns.extend(['_build'])

[rtd-command-info] start-time: 2022-05-04T08:08:14.955533Z, end-time: 2022-05-04T08:08:15.794693Z, duration: 0, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/pycgm2/envs/latest/bin/python -m sphinx -T -E -W --keep-going -b html -d _build/doctrees -D language=en . _build/html
Running Sphinx v4.5.0
loading translations [en]... done
making output directory... done
myst v0.17.2: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=[], linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, highlight_code_blocks=True, number_code_blocks=[], title_to_header=False, heading_anchors=None, heading_slug_func=None, footnote_transition=True, sub_delimiters=('{', '}'), words_per_minute=200)
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 2 source files that are out of date
updating environment: [new config] 2 added, 0 changed, 0 removed
reading sources... [ 50%] index
reading sources... [100%] usage

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 50%] index
writing output... [100%] usage

generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.
Updating searchtools for Read the Docs search...
@stsewd
Copy link
Member

stsewd commented May 4, 2022

Hi, I'm able to see the contents from https://github.com/pyCGM2/pyCGM2/blob/Master/docs/source/index.md in https://pycgm2.readthedocs.io/en/latest/. If you don't see that, that's probable your browser cache, try a hard refresh (ctrl-f5 on firefox).

@stsewd stsewd added Support Support question Needed: more information A reply from issue author is required labels May 4, 2022
@aaa34169
Copy link
Author

aaa34169 commented May 4, 2022 via email

@stsewd
Copy link
Member

stsewd commented May 4, 2022

#9167

@stsewd stsewd closed this as completed May 4, 2022
@sgbaird sgbaird mentioned this issue May 28, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Needed: more information A reply from issue author is required Support Support question
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@aaa34169 @stsewd