Open yannickl88 opened 7 years ago
As far as I can remember, docs are generated per-project. @beberlei do we have an entry-point script used to re-generate the website?
Marco Pivetta
On Fri, Apr 14, 2017 at 9:03 PM, Yannick de Lange notifications@github.com wrote:
I would like to bring this up in a separate issue so it give me a bit more freedom to ask questions which are not related to the original issue.
I've ran into two problems:
- When trying to generate the docs I get a KeyError in site_exts\doctrinedownloads.py at line 27. Commenting this line will "fix" the issue that the issue_link will not be added.
- Generation only seems to happend for the contents of this project. Any docs in all the other doctrine documents seems to be missing. Is there a workflow to get the complete site together? Or should the docs be generated for each project individually?
The output of the generate.sh script for me is:
$ ./generate.sh ./generate.sh: line 2: cd: /var/www/doctrine-website-sphinx: No such file or dir ectory From https://github.com/doctrine/doctrine-website-sphinx
- branch master -> FETCH_HEAD Already up-to-date. Running Sphinx v1.5.5 WARNING: The config value
html_add_permalinks' has type
NoneType', defaults to `unicode'. loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [html]: targets for 304 source files that are out of date updating environment: 304 added, 0 changed, 0 removed reading sources... [100%] projects/phpcr-odm .8arious_doctrine_projects D:\projects\doctrine-website-sphinx\site\2008\10\19\the-bleeding-edge-website-upgraded.rst:47: WARNING: nonlocal image URI found: http://www.doctrine-project.com/uploads/assets/api_release_list.png D:\projects\doctrine-website-sphinx\site\2008\10\19\the-bleeding-edge-website-upgraded.rst:60: WARNING: nonlocal image URI found: http://www.doctrine-project.com/uploads/assets/edit_user_svn_access.png D:\projects\doctrine-website-sphinx\site\2008\10\19\the-bleeding-edge-website-upgraded.rst:71: WARNING: nonlocal image URI found: http://www.doctrine-project.com/uploads/assets/api_release_points_list.png D:\projects\doctrine-website-sphinx\site\2008\10\19\the-bleeding-edge-website-upgraded.rst:83: WARNING: nonlocal image URI found: http://www.doctrine-project.com/uploads/assets/edit_api_release.png D:\projects\doctrine-website-sphinx\site\2008\10\19\the-bleeding-edge-website-upgraded.rst:None: WARNING: nonlocal image URI found: http://www.doctrine-project.com/uploads/assets/edit_blog_post.png D:\projects\doctrine-website-sphinx\site\2008\10\26\symfony-doctrine-schema-manager.rst:32: WARNING: nonlocal image URI found: http://www.symfony-project.org/uploads/plugins/5e25c2c7775a8ed169e2d9a6de8e2d1d98ffd110.png D:\projects\doctrine-website-sphinx\site\2008\12\03\first-1-1-alpha-version-released.rst:2: WARNING: Duplicate explicit target name: "here". D:\projects\doctrine-website-sphinx\site\2009\03\02\doctrine-1-0-8-and-1-1-0-rc2-released.rst:2: WARNING: Duplicate explicit target name: "here". D:\projects\doctrine-website-sphinx\site\2009\07\04\major-site-enhancements.rst:2: WARNING: Duplicate explicit target name: "here". D:\projects\doctrine-website-sphinx\site\2009\07\04\major-site-enhancements.rst:2: WARNING: Duplicate explicit target name: "here". D:\projects\doctrine-website-sphinx\site\2009\08\24\doctrine-2-0-quality-assurance.rst:114: WARNING: nonlocal image URI found: http://www.doctrine-project.org/blog-images/doctrine-2-0-qa/picture2.png D:\projects\doctrine-website-sphinx\site\2009\08\24\doctrine-2-0-quality-assurance.rst:120: WARNING: nonlocal image URI found: http://www.doctrine-project.org/blog-images/doctrine-2-0-qa/picture3.png D:\projects\doctrine-website-sphinx\site\2009\11\03\a-doctrine-triple-play.rst:2: WARNING: Duplicate explicit target name: "change log". D:\projects\doctrine-website-sphinx\site\2009\11\03\a-doctrine-triple-play.rst:2: WARNING: Duplicate explicit target name: "change log". D:\projects\doctrine-website-sphinx\site\2010\05\27\bringing-it-all-together.rst:2: WARNING: Duplicate explicit target name: "dbal". D:\projects\doctrine-website-sphinx\site\2010\05\27\bringing-it-all-together.rst:2: WARNING: Duplicate explicit target name: "orm". D:\projects\doctrine-website-sphinx\site\2010\07\19\your-own-orm-doctrine2.rst:121: WARNING: Inline strong start-string without end-string. D:\projects\doctrine-website-sphinx\site\2010\09\01\birthday-release-party.rst:2: WARNING: Duplicate explicit target name: "installation". D:\projects\doctrine-website-sphinx\site\2010\09\01\birthday-release-party.rst:2: WARNING: Duplicate explicit target name: "changelog". D:\projects\doctrine-website-sphinx\site\2010\09\01\birthday-release-party.rst:2: WARNING: Duplicate explicit target name: "installation". D:\projects\doctrine-website-sphinx\site\2010\09\01\birthday-release-party.rst:2: WARNING: Duplicate explicit target name: "changelog". D:\projects\doctrine-website-sphinx\site\2010\11\18\doctrine2-behavioral-extensions.rst:644: ERROR: Content block expected for the "raw" directive; none found. D:\projects\doctrine-website-sphinx\site\2011\05\16\doctrine-2-1-beta-release.rst:2: WARNING: Duplicate explicit target name: "tutorial for this feature". D:\projects\doctrine-website-sphinx\site\2011\05\16\doctrine-2-1-beta-release.rst:35: WARNING: Inline interpreted text or phrase reference start-string without end-string. D:\projects\doctrine-website-sphinx\site\2011\07\04\doctrine-2-1.rst:2: WARNING: Duplicate explicit target name: "tutorial for this feature". D:\projects\doctrine-website-sphinx\site\2011\07\04\doctrine-2-1.rst:41: WARNING: Inline interpreted text or phrase reference start-string without end-string. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:44: WARNING: Bullet list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:44: WARNING: Inline strong start-string without end-string. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:45: WARNING: Definition list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:47: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:47: WARNING: Inline strong start-string without end-string. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:50: WARNING: Inline strong start-string without end-string. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:53: WARNING: Inline strong start-string without end-string. D:\projects\doctrine-website-sphinx\site\2011\11\21\a-doctrine-orm-odm-base-class.rst:55: WARNING: Block quote ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2011\12\19\doctrine-2-1-5.rst:10: ERROR: Unknown target name: "github <https://github.com/doctrine/doctrine2/tree/2.1.5". D:\projects\doctrine-website-sphinx\site\2011\12\20\doctrine2-2-beta.rst:32: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2011\12\20\doctrine2-2-beta.rst:33: WARNING: Block quote ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2011\12\20\doctrine2-2-beta.rst:34: WARNING: Definition list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2011\12\20\doctrine2-2-beta.rst:27: ERROR: Unknown target name: "pear http://pear.doctrine-project.org>". D:\projects\doctrine-website-sphinx\site\2012\01\03\doctrine2-2-beta2.rst:16: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2012\01\03\doctrine2-2-beta2.rst:17: WARNING: Block quote ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2012\01\03\doctrine2-2-beta2.rst:18: WARNING: Definition list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2012\01\29\doctrine-2-2-final.rst:31: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2012\01\29\doctrine-2-2-final.rst:32: WARNING: Block quote ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2012\01\29\doctrine-2-2-final.rst:33: WARNING: Definition list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2012\03\04\doctrine-2-2-1-released.rst:17: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2012\03\04\doctrine-2-2-1-released.rst:18: WARNING: Block quote ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2012\03\04\doctrine-2-2-1-released.rst:19: WARNING: Definition list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2012\09\20\doctrine-2-3-final.rst:2: WARNING: Duplicate explicit target name: "dbal". D:\projects\doctrine-website-sphinx\site\2012\09\20\doctrine-2-3-final.rst:2: WARNING: Duplicate explicit target name: "orm". D:\projects\doctrine-website-sphinx\site\2013\09\11\doctrine-2-4-released.rst:2: WARNING: Duplicate explicit target name: "documentation". D:\projects\doctrine-website-sphinx\site\2013\09\11\doctrine-2-4-released.rst:2: WARNING: Duplicate explicit target name: "documentation". D:\projects\doctrine-website-sphinx\site\2013\09\11\doctrine-2-4-released.rst:2: WARNING: Duplicate explicit target name: "documentation". D:\projects\doctrine-website-sphinx\site\2014\12\04\doctrine_dbal_2_5_release.rst:16: ERROR: Error in "code-block" directive: maximum 1 argument(s) allowed, 4 supplied... code-block:: shell composer require doctrine/dbal:~2.5 D:\projects\doctrine-website-sphinx\site\2014\12\16\orm-247.rst:9: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2015\01\25\orm-2-5-0-alpha-2.rst:112: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2015\03\25\orm-2-5-0-rc-1.rst:48: WARNING: Explicit markup ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2015\03\25\orm-2-5-0-rc-1.rst:48: WARNING: Inline literal start-string without end-string. D:\projects\doctrine-website-sphinx\site\2015\03\25\orm-2-5-0-rc-1.rst:48: WARNING: Inline interpreted text or phrase reference start-string without end-string. D:\projects\doctrine-website-sphinx\site\2015\03\31\orm-2-5-0-rc-2.rst:45: WARNING: Explicit markup ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2015\03\31\orm-2-5-0-rc-2.rst:45: WARNING: Inline literal start-string without end-string. D:\projects\doctrine-website-sphinx\site\2015\03\31\orm-2-5-0-rc-2.rst:45: WARNING: Inline interpreted text or phrase reference start-string without end-string. D:\projects\doctrine-website-sphinx\site\2015\11\23\orm-2-5-2.rst:2: WARNING: Duplicate explicit target name: "gh-1375". D:\projects\doctrine-website-sphinx\site\2015\11\23\orm-2-5-2.rst:2: WARNING: Duplicate explicit target name: "gh-1375". D:\projects\doctrine-website-sphinx\site\2015\11\23\orm-2-5-2.rst:2: WARNING: Duplicate explicit target name: "gh-1375". D:\projects\doctrine-website-sphinx\site\2015\11\23\orm-2-5-2.rst:2: WARNING: Duplicate explicit target name: "gh-1375". D:\projects\doctrine-website-sphinx\site\2015\11\23\orm-2-5-2.rst:2: WARNING: Duplicate explicit target name: "gh-1375". D:\projects\doctrine-website-sphinx\site\2015\11\23\orm-2-5-2.rst:2: WARNING: Duplicate explicit target name: "gh-1375". D:\projects\doctrine-website-sphinx\site\2015\12\03\cache-1-5-2.rst:12: WARNING: Inline literal start-string without end-string. D:\projects\doctrine-website-sphinx\site\2016\06\09\odm-1-1-0-and-1-0-6.rst:57: ERROR: Unexpected indentation. D:\projects\doctrine-website-sphinx\site\2016\06\09\odm-1-1-0-and-1-0-6.rst:58: WARNING: Block quote ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2016\10\07\doctrine-mongodb-odm-release-1.1.2-and-1.0.8.rst:12: WARNING: Bullet list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\2016\10\07\doctrine-mongodb-odm-release-1.1.2-and-1.0.8.rst:23: WARNING: Bullet list ends without a blank line; unexpected unindent. D:\projects\doctrine-website-sphinx\site\master.rst:10: WARNING: toctree contains reference to nonexisting document u'2015/12/02/doctrine-module-0.10-0' D:\projects\doctrine-website-sphinx\site\master.rst:10: WARNING: toctree contains reference to nonexisting document u'2015/08/19/doctrine_orm_2_5_1_and_2_4_8_released' looking for now-outdated files... none found pickling environment... done checking consistency... D:\projects\doctrine-website-sphinx\site\2014\09\23\orm-245.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\2014\10\06\orm-246.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\2014\10\16\dbal-243.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\2015\12\02\doctrine-module-0-10-0.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\about.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\annotations.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\cache.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\collections.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\common.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\couchdb-odm.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\dbal.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\indoctrinator.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\inflector.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\lexer.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\migrations.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\mongodb.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\mongodb-odm.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\orientdb-odm.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\orm.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\ormold.rst:: WARNING: document isn't included in any toctree D:\projects\doctrine-website-sphinx\site\projects\phpcr-odm.rst:: WARNING: document isn't included in any toctree done preparing documents... done D:\projects\doctrine-website-sphinx\site\2009\01\26\php-5-3-and-doctrine-2-0-teaser.rst:20: WARNING: Could not lex literal_block as "php". Highlighting skipped. D:\projects\doctrine-website-sphinx\site\2009\02\04\using-behaviors-to-share-relationship-properties.rst:64: WARNING: Could not lex literal_block as "php". Highlighting skipped. D:\projects\doctrine-website-sphinx\site\2009\05\28\doctrine-database-abstraction-layer.rst:101: WARNING: Could not lex literal_block as "php". Highlighting skipped. D:\projects\doctrine-website-sphinx\site\2010\07\20\mixing-types-of-documents.rst:96: WARNING: Could not lex literal_block as "php". Highlighting skipped. D:\projects\doctrine-website-sphinx\site\2015\04\01\indoctrinator-0-0-1-alpha-1.rst:29: WARNING: Could not lex literal_block as "json". Highlighting skipped. writing output... [ 95%] projects/annotations 8arious_doctrine_projects Exception occurred: File "D:\projects\doctrine-website-sphinx\site_exts\doctrinedownloads.py", line 72, in visit_doctrinedownloads_html self.body.append('
Issues \n' % (node['project']['issues_link']) ) KeyError: 'issues_link' The full traceback has been saved in c:\users\me\appdata\local\temp\sphinx-err-7kqebc.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at https://github.com/sphinx-doc/sphinx/issues. Thanks!Before you ask, I tested also on a linux machine; same error.
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/doctrine/doctrine-website-sphinx/issues/150, or mute the thread https://github.com/notifications/unsubscribe-auth/AAJakOsZIg59cPzFNEvmwe9b8gkYJS3Uks5rv8L1gaJpZM4M-AYM .
If you could tell me what to put where I could make or extend the generation script to do so. I think it would be valuable for new people to have a way to clone everything.
Because now the inter-project links all link to the http://docs.doctrine-project.org
domain, which makes clicking through it locally a bit of a pain. Would be nice to also have those relative.
I would like to bring this up in a separate issue so it give me a bit more freedom to ask questions which are not related to the original issue.
I've ran into two problems:
KeyError
insite\_exts\doctrinedownloads.py
at line 27. Commenting this line will "fix" the issue that the issue_link will not be added.The output of the
generate.sh
script for me is: