Skip to content
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.

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

Minor issues with build_sphinx #662

Merged
merged 1 commit into from
Aug 2, 2018
Merged

Conversation

Tontyna
Copy link
Contributor

@Tontyna Tontyna commented Aug 1, 2018

After creating an editable environment with Sphinx and everything for WeasyPrint -- BTW: On Windows the activate command is located in env/Scripts, not in env/bin, will edit hacking.rst later -- I tried to build the docs by issuing python setup.py build_sphinx.

Got no htmls but Theme error: sphinx_rtd_theme is no longer a hard dependency since version 1.4.0. Please install it manually.(pip install sphinx_rtd_theme).
Don't know how / in which config-or-what-file this can be fixed or whether it should be fixed at all... problem solved by running pip install.

After that the expected htmls were created successfully, though with some WARNINGs. The 4 warnings about :ref:not finding its target are solved by 2ea0c6c.

@Tontyna
Copy link
Contributor Author

Tontyna commented Aug 1, 2018

There is another WARNING about not finding the intersphinx inventory of cairocffi. This one can only be solved by cairocffi maintainers. But as far as I could see: In the whole doc no intersphinx-link to cairocffi.

Since there are no intersphinx links at all to nothing, the whole intersphinx_mapping in config.py is obsolete, but maybe it's for future use...

@Tontyna
Copy link
Contributor Author

Tontyna commented Aug 1, 2018

Was tempted to eliminate the last WARNING about favicon file 'icon.ico' does not exist. That's a lie, the icon lives in the _static subfolder. Which, according to the comments in config.py should be the right place.

In contrast, the current Sphinx doc tells me that html_favicon path should be relative to the configuration directory.

Sounds like they changed that recently and I better live with the warning -- the files from the _static folder are copied to _build\html\_static, anyway.

@Tontyna
Copy link
Contributor Author

Tontyna commented Aug 1, 2018

...until today I had no idea what those /envand /venv entries in .gitignore are supposed to prevent...

@liZe
Copy link
Member

liZe commented Aug 2, 2018

Thanks a lot for the fixes.

Don't know how / in which config-or-what-file this can be fixed or whether it should be fixed at all... problem solved by running pip install.

As we host docs on ReadTheDocs, the style is already installed. As there's already a nice message, I think it's OK.

After that the expected htmls were created successfully, though with some WARNINGs. The 4 warnings about :ref:not finding its target are solved by 2ea0c6c.

Thank you.

There is another WARNING about not finding the intersphinx inventory of cairocffi. This one can only be solved by cairocffi maintainers. But as far as I could see: In the whole doc no intersphinx-link to cairocffi.

I'll check that.

Sounds like they changed that recently and I better live with the warning -- the files from the _static folder are copied to _build\html_static, anyway.

I'll check that too.

...until today I had no idea what those /env and /venv entries in .gitignore are supposed to prevent...

These are quite standard virtual environment folders, but I'll remove them, people should put their virtualenvs somewhere else.

@liZe liZe merged commit 2fba2af into Kozea:master Aug 2, 2018
@Tontyna
Copy link
Contributor Author

Tontyna commented Aug 2, 2018

but I'll remove them, people should put their virtualenvs somewhere else.

Dont!

If you do and someone confidentlly follows the instructions in Hacking WeasyPrint, sets up an environment where build_sphinx works because she wants to contribute to the documentation and wants to check her work before pushing...

I mean: people who know how to setup virtualenvs and Sphinx and everything wont need those instructions anyway and the .gitignore entries dont hurt.

@Tontyna Tontyna deleted the contrib_to_doc branch August 2, 2018 20:28
@liZe liZe added this to the 43 milestone Aug 3, 2018
@liZe liZe added the documentation Problems or improvements needed on the documentation or on the website label Aug 3, 2018
netbsd-srcmastr referenced this pull request in NetBSD/pkgsrc Nov 14, 2018
Version 43
----------

Released on 2018-11-09.

Bug fixes:

* `#726 <https://github.com/Kozea/WeasyPrint/issues/726>`_:
  Make empty strings clear previous values of named strings
* `#729 <https://github.com/Kozea/WeasyPrint/issues/729>`_:
  Include tools in packaging

This version also includes the changes from unstable rc1 and rc2 versions
listed below.

Version 43rc2
-------------

Released on 2018-11-02.

**This version is experimental, don't use it in production. If you find bugs,
please report them!**

Bug fixes:

* `#706 <https://github.com/Kozea/WeasyPrint/issues/706>`_:
  Fix text-indent at the beginning of a page
* `#687 <https://github.com/Kozea/WeasyPrint/issues/687>`_:
  Allow query strings in file:// URIs
* `#720 <https://github.com/Kozea/WeasyPrint/issues/720>`_:
  Optimize minimum size calculation of long inline elements
* `#717 <https://github.com/Kozea/WeasyPrint/issues/717>`_:
  Display <details> tags as blocks
* `#691 <https://github.com/Kozea/WeasyPrint/issues/691>`_:
  Don't recalculate max content widths when distributing extra space for tables
* `#722 <https://github.com/Kozea/WeasyPrint/issues/722>`_:
  Fix bookmarks and strings set on images
* `#723 <https://github.com/Kozea/WeasyPrint/issues/723>`_:
  Warn users when string() is not used in page margin


Version 43rc1
-------------

Released on 2018-10-15.

**This version is experimental, don't use it in production. If you find bugs,
please report them!**

Dependencies:

* Python 3.4+ is now needed, Python 2.x is not supported anymore
* Cairo 1.15.4+ is now needed, but 1.10+ should work with missing features
  (such as links, outlines and metadata)
* Pdfrw is not needed anymore

New features:

* `Beautiful website <https://weasyprint.org>`_
* `#579 <https://github.com/Kozea/WeasyPrint/issues/579>`_:
  Initial support of flexbox
* `#592 <https://github.com/Kozea/WeasyPrint/pull/592>`_:
  Support @font-face on Windows
* `#306 <https://github.com/Kozea/WeasyPrint/issues/306>`_:
  Add a timeout parameter to the URL fetcher functions
* `#594 <https://github.com/Kozea/WeasyPrint/pull/594>`_:
  Split tests using modern pytest features
* `#599 <https://github.com/Kozea/WeasyPrint/pull/599>`_:
  Make tests pass on Windows
* `#604 <https://github.com/Kozea/WeasyPrint/pull/604>`_:
  Handle target counters and target texts
* `#631 <https://github.com/Kozea/WeasyPrint/pull/631>`_:
  Enable counter-increment and counter-reset in page context
* `#622 <https://github.com/Kozea/WeasyPrint/issues/622>`_:
  Allow pathlib.Path objects for HTML, CSS and Attachment classes
* `#674 <https://github.com/Kozea/WeasyPrint/issues/674>`_:
  Add extensive installation instructions for Windows

Bug fixes:

* `#558 <https://github.com/Kozea/WeasyPrint/issues/558>`_:
  Fix attachments
* `#565 <https://github.com/Kozea/WeasyPrint/issues/565>`_,
  `#596 <https://github.com/Kozea/WeasyPrint/issues/596>`_,
  `#539 <https://github.com/Kozea/WeasyPrint/issues/539>`_:
  Fix many PDF rendering, printing and compatibility problems
* `#614 <https://github.com/Kozea/WeasyPrint/issues/614>`_:
  Avoid crashes and endless loops caused by a Pango bug
* `#662 <https://github.com/Kozea/WeasyPrint/pull/662>`_:
  Fix warnings and errors when generating documentation
* `#666 <https://github.com/Kozea/WeasyPrint/issues/666>`_,
  `#685 <https://github.com/Kozea/WeasyPrint/issues/685>`_:
  Fix many table layout rendering problems
* `#680 <https://github.com/Kozea/WeasyPrint/pull/680>`_:
  Don't crash when there's no font available
* `#662 <https://github.com/Kozea/WeasyPrint/pull/662>`_:
  Fix support of some align values in tables
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Problems or improvements needed on the documentation or on the website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants