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

Declare the main entry point of the package #655

Merged
merged 8 commits into from Oct 5, 2018

Conversation

Projects
None yet
4 participants
@davidfischer
Contributor

davidfischer commented Jun 28, 2018

This is needed after installing with npm to use require.

@davidfischer davidfischer requested review from jessetan and Blendify Jun 28, 2018

@jessetan

This comment has been minimized.

Show comment
Hide comment
@jessetan

jessetan Jun 29, 2018

Contributor

What usecase is supported by installing using npm?
The theme code in js/theme.js does not make sense on its own. It needs the additional assets in sphinx_rtd_theme/static

Contributor

jessetan commented Jun 29, 2018

What usecase is supported by installing using npm?
The theme code in js/theme.js does not make sense on its own. It needs the additional assets in sphinx_rtd_theme/static

@davidfischer

This comment has been minimized.

Show comment
Hide comment
@davidfischer

davidfischer Jun 29, 2018

Contributor

What usecase is supported by installing using npm?

Readthedocs.org bundles the theme.js in some cases and fetches it through bower. If we want to swap out bower for NPM and just do require('sphinx_rtd_theme') we will need this.

Contributor

davidfischer commented Jun 29, 2018

What usecase is supported by installing using npm?

Readthedocs.org bundles the theme.js in some cases and fetches it through bower. If we want to swap out bower for NPM and just do require('sphinx_rtd_theme') we will need this.

@davidfischer

This comment has been minimized.

Show comment
Hide comment
@davidfischer

davidfischer Jun 29, 2018

Contributor

Bower is deprecated and no longer recommended.

Contributor

davidfischer commented Jun 29, 2018

Bower is deprecated and no longer recommended.

@jessetan

This comment has been minimized.

Show comment
Hide comment
@jessetan

jessetan Jul 4, 2018

Contributor

OK. Does it make sense to make sphinx_rtd_theme/static/js/theme.js the entry point as it is the generated JS or will RTD run it through it's own compilation/minification process?

Contributor

jessetan commented Jul 4, 2018

OK. Does it make sense to make sphinx_rtd_theme/static/js/theme.js the entry point as it is the generated JS or will RTD run it through it's own compilation/minification process?

@davidfischer

This comment has been minimized.

Show comment
Hide comment
@davidfischer

davidfischer Jul 6, 2018

Contributor

Typically you don't specify a compressed file as the default entry point as whatever is including it should do it's own compilation process.

Contributor

davidfischer commented Jul 6, 2018

Typically you don't specify a compressed file as the default entry point as whatever is including it should do it's own compilation process.

ericholscher and others added some commits Oct 5, 2018

@davidfischer davidfischer merged commit 4a3d790 into master Oct 5, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@davidfischer davidfischer deleted the davidfischer/declare-package-main branch Oct 5, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment