Docs: update product help links #391
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ludovicsteinbach
changed the base branch from
main
to
maint/merge-from-private
Andy-Grigg
approved these changes
Jan 16, 2024
Andy-Grigg
added a commit
that referenced
this pull request
Jan 16, 2024
* Remove outdated typevars * Include finishing processes in summary * Update example BoM * Create 4-2_BoM_Sustainability.py * Add example to docs * Sustainability example changes * Fix server name * Tweak working * Change BoM naming convention * Add API link and minor formatting tweaks * Change legend position * Uncomment integration tests job * Make sure this class isn't collected by pytest * Rename with_legislations to with_legislation_ids * Add trailing space * Rename external_id on part to external_identity * Enforce keywords for indicator constructors * Run black * Copy check_server from recordlists * Add variable to disable vm state management * Fix error message * Fix typo * Use absolute masses for secondary processes and use floats * Draft bom builder example * Add example to docs * Fix typing * Remove some boms * Improve sustainability integration tests * Fix error message * PR feedback * Apply language suggestions from code review Co-authored-by: Andy Grigg <[email protected]> * Add delimiters and fix comments * Fix GUID field name * Use method for record references * Fix test assertions (due to mass changes in BoM) * Change plotly renderer in examples tests [skip-ci] * Update BillOfMaterialsEco2301.xsd * Add category enum * Update sus. tests to reflect aggregation changes * Remove outdated todo * Fix error message * Fix missing database test * Add initial docs for BoM Types - Add rst - Move init docstrings to class. I hate this, the docstring then says that a class takes a parameter. It does not. The init does. - Add docstrings for protocols. * Update files for 2024 R1 * Ignore deserialization * Exclude the right thing * Move a docstring and update the other ignorewords... * Try without tildes * Pin vale? * There is no 2.28 * Update index.rst * Update README.rst * Clarify aggregation methodology * Add links to online docs * Add record identification documentation * Remove id notes * Remove "do not instantiate" notes * Fix message typing * Update summary results docstrings * Bump openapi package * Remove sustainability blank coatings * Remove sustainability from specifications * Remove substances from MaterialWithSustainability * Fix issues with Quantity - Treat $ as a special case and never handle namespaces - Handle attributes with no namespace if no default namespace is present * Add name to transport results * Update examples.py * Update unit tests * Use merge commit ref * Update tests/test_item_results.py Co-authored-by: Doug Addy <[email protected]> * Create BillOfMaterialsEco1711.xsd * Schemas sub-package * Remove schemas from examples * Review comments * Expect warnings in tests * Make inputs mandatory * Naive support for multiple BoM versions * Add notes about schemas and schemas to docs * Rename sample bom * Delete unused test helpers * Update test_integration_tests.py * Modify invalid bom to pass client side validation * Fix fixture name * Add custom tables for sustainability * Fix failing integration tests * Minor feedback * Fix database key * Fix vale vocab * Remove use of regex * Remove messages assertions * Update docs * Remove results classes * Update tests * Remove from docs * Update PartWithSustainability docstring * Compose record references * Add part number * Update tests * Correct typing * Update mock responses and associated tests * Update dependency * Make mixin into base class * Use merge commit ref * Warn on multiple root parts in sust. query result * Update warning * Add part and transport references to docs * Update docs homepage * Update GitHub org name * Update MI version requirements * Add note about product licensing * Update Process properties names and docs * Update BoM builder example * Update example bom * Remove duplicated BoM * Rename test BoMs * Remove duplicated BoM * Rename paths variables * Add variables for extra boms * Use newer version of vale * Convert to dataclasses * Update bom types docs Remove protocols and base class * Fix bom types issues * Comment out troublesome properties NonMIPartReference and BoM annotations * Add test * Fix typing and formatting * Apply suggestions from code review Co-authored-by: Andy Grigg <[email protected]> * Remove special handling for ids * Comment out annotations * Address more small issues Remove typical content on materials * Add comment about BoM "update" * Add TODOs with issue ID * Ignore numpydoc warning * Add missing docstrings * Address vale issues * Update accept.txt * Update accept.txt * Add test for unexpected args * Script tweaks * Update .vale.ini * Update common identifiers documentation * Add missing punctuation * Wording feedback * Bump actions/checkout from 3 to 4 Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Remove test bom * Fix doc header * Add badges to README * Sustainability docs tweaks * Fix/ignore reference warnings * Typo in example * Clarify env. footprint hierarchy * Remove TODO * Updates to bom builder example script * Update package index * Add note about item expansion * Fix error message * Document aggregation criteria * Flake8 * Add space * Language feedback * Re-ordering * Add missing mian dependencies * Poetry lock with update * Update emails * Use openapi PR ref * Drop Python 3.8 * Support Python 3.12 * Fix tox config * Use merge commit ref * Update docs dependencies * Update comment * Loosen specifications * Bump pandas from 2.0.3 to 2.1.3 Bumps [pandas](https://github.com/pandas-dev/pandas) from 2.0.3 to 2.1.3. - [Release notes](https://github.com/pandas-dev/pandas/releases) - [Commits](pandas-dev/pandas@v2.0.3...v2.1.3) --- updated-dependencies: - dependency-name: pandas dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Remove with_stk_records (#123) * Fix: add repr and example formatting (#122) * Fix formatting * Update 4-2_BoM_Sustainability.py * Add sustainability query repr * Maint: Update docs deps (#127) * Feat: Single part in BoM sustainability (#130) * Expose single part * Raise error on no parts * Docs: PM feedback (#132) * Reduce output * Add note about relevance of items * Update accept.txt * Apply suggestions from code review Co-authored-by: Andy Grigg <[email protected]> * Make vale happy --------- Co-authored-by: Andy Grigg <[email protected]> * Bump jupytext from 1.15.2 to 1.16.0 (#133) Bumps [jupytext](https://github.com/mwouts/jupytext) from 1.15.2 to 1.16.0. - [Release notes](https://github.com/mwouts/jupytext/releases) - [Changelog](https://github.com/mwouts/jupytext/blob/main/CHANGELOG.md) - [Commits](mwouts/jupytext@v1.15.2...v1.16.0) --- updated-dependencies: - dependency-name: jupytext dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Docs: review feedback (#142) * RS and Compliance updates * Sustainability updates * BoM types updates * Examples updates * Fix typo * Fix typo [skip-ci] Co-authored-by: Andy Grigg <[email protected]> --------- Co-authored-by: Andy Grigg <[email protected]> * Allow null material identity and reference * Add first draft of general improvements to documentation * Vale fixes * Add note to compliance API page * Move license note to end * Fix BoM query descriptions * Fix typo * Documentation review feedback * Point at public bomanalytics-openapi * Fix cname * Clean up workflows * Use public bomanalytics-openapi * Maint/codacy fixes (#388) * Codacy fixes * Add dummy variable * Add metapackage instructions (#390) * Docs: update product help links (#391) * Fix broken reference * Update Product Docs URL --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Ludovic Steinbach <[email protected]> Co-authored-by: Doug Addy <[email protected]> Co-authored-by: Doug Addy <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the root url for external links to the product help site.
I've checked all the links with the new root and they all are functioning.